createInvitedAccount

POST /api/public/account/invited-account

Headers

X-Gatego-oid

Specify effective organization_id for Admin and Group Organization Admins. This is a global header for all endpoints only taken into consideration when it makes sense (it won't be used in Auth, for example)

application/json

Body

account_invited

Same account request as in the POST /account private endpoint, without the fields forced by the original invitation (eg. email, role) the rest will be ignored
code string

Private code sent to the invited user to confirm the invitation, no account will be created if the code is invalid

Responses

201 */*

Created
Hide response attributes Show response attributes object
- active boolean
- can_view_carrier_ids array[integer(int64)]
- can_view_other_carriers boolean
- carrier_id integer(int64)
- deleted_at string(date-time)
- driver object
  
  Hide driver attributes Show driver attributes object
  
  license string
  
  license_expiration string(date-time)
  
  license_picture_id string
  
  photo_id string
  
  safety_card_picture_id string
  
  truck_number string
- driver_license string
- driver_license_expiration string(date-time)
- driver_license_picture_id integer(int64)
- driver_photo_id integer(int64)
- driver_safety_card_picture_id integer(int64)
- driver_truck_number string
- email string
- email_confirmed boolean
  
  Whether user has confirmed his email address
- hmac string
  
  HMAC-SHA256 of the user id
- hmac_android string
- hmac_ios string
- id integer(int64)
- language_code string
- last_login string(date-time)
- last_login_app_version string
- last_login_referer string
- managed_organization_group object
  
  Hide managed_organization_group attributes Show managed_organization_group attributes object
  
  id integer(int64)
  
  managed_organizations array[object]
  
  Hide managed_organizations attributes Show managed_organizations attributes object
  
  id integer(int64)
  
  name string
  
  name string
- name string
- organization object
  
  Hide organization attributes Show organization attributes object
  
  id integer(int64)
  
  name string
- phone_number string
- previous_last_login string(date-time)
- role string
  
  Values are ADMIN, CARRIER_ADMIN, DRIVER, GUARD, ORG_ADMIN, ORG_GROUP_ADMIN, RESTRICTED_GUARD, SIGNUP_SERVICE, SUPER_CARRIER_ADMIN, YARD_ADMIN, or YARD_DRIVER.
- username string
- yard_id integer(int64)
401

Unauthorized
403

Forbidden
404

Not Found

POST /api/public/account/invited-account

curl \
 -X POST http://localhost:8080/api/public/account/invited-account \
 -H "Content-Type: application/json" \
 -d '{"code":"string"}'

Request examples

# Headers

# Payload
{
  "code": "string"
}

Response examples (201)

{
  "active": true,
  "can_view_carrier_ids": [
    42
  ],
  "can_view_other_carriers": true,
  "carrier_id": 42,
  "deleted_at": "2024-05-04T09:42:00+00:00",
  "driver": {
    "license": "string",
    "license_expiration": "2024-05-04T09:42:00+00:00",
    "license_picture_id": "string",
    "photo_id": "string",
    "safety_card_picture_id": "string",
    "truck_number": "string"
  },
  "driver_license": "string",
  "driver_license_expiration": "2024-05-04T09:42:00+00:00",
  "driver_license_picture_id": 42,
  "driver_photo_id": 42,
  "driver_safety_card_picture_id": 42,
  "driver_truck_number": "string",
  "email": "string",
  "email_confirmed": false,
  "hmac": "string",
  "hmac_android": "string",
  "hmac_ios": "string",
  "id": 42,
  "language_code": "string",
  "last_login": "2024-05-04T09:42:00+00:00",
  "last_login_app_version": "string",
  "last_login_referer": "string",
  "managed_organization_group": {
    "id": 42,
    "managed_organizations": [
      {
        "id": 42,
        "name": "string"
      }
    ],
    "name": "string"
  },
  "name": "string",
  "organization": {
    "id": 42,
    "name": "string"
  },
  "phone_number": "string",
  "previous_last_login": "2024-05-04T09:42:00+00:00",
  "role": "ADMIN",
  "username": "string",
  "yard_id": 42
}