Auth

Start device login

Starts a CLI device login flow.

post/v1/login/device

Response

Device login started.

loginUrlstring uri required

verificationUristring uri required

deviceCodestring required

userCodestring required

intervalSecondsinteger required

expiresInSecondsinteger required

Example response

{
  "loginUrl": "https://tovuk.com/login?device_code=zdev_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
  "verificationUri": "https://tovuk.com/login",
  "deviceCode": "zdev_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
  "userCode": "TOVUK-123",
  "intervalSeconds": 5,
  "expiresInSeconds": 600
}

Changes

Changed in 2 of the 50 revisions of this API.26482

Jul 3, 20263f7925dc651d46See the full diff
- ▲
  removed the required property device_code from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property expires_in from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property interval from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property verification_uri from the response with the 200 status
  response-required-property-removed
- ○
  added the required property deviceCode to the response with the 200 status
  response-required-property-added
- ○
  added the required property expiresInSeconds to the response with the 200 status
  response-required-property-added
- ○
  added the required property intervalSeconds to the response with the 200 status
  response-required-property-added
- ○
  added the required property loginUrl to the response with the 200 status
  response-required-property-added
- ○
  added the required property userCode to the response with the 200 status
  response-required-property-added
- ○
  added the required property verificationUri to the response with the 200 status
  response-required-property-added
Jun 5, 20263985c6090c9122476See the full diff
- ▲
  the response property checkout_url became nullable for the status 400
  response-property-became-nullable
- ▲
  the response property checkout_url became nullable for the status 401
  response-property-became-nullable
- ▲
  the response property checkout_url became nullable for the status 429
  response-property-became-nullable
- ▲
  the response property checkout_url became nullable for the status 500
  response-property-became-nullable
- ▲
  the response property checkout_url became optional for the status 400
  response-property-became-optional
- ▲
  the response property checkout_url became optional for the status 401
  response-property-became-optional
- ▲
  the response property checkout_url became optional for the status 429
  response-property-became-optional
- ▲
  the response property checkout_url became optional for the status 500
  response-property-became-optional
- ▲
  the agent_instruction response property's maxLength was unset from 1000 for the response status 400
  response-property-max-length-unset
- ▲
  the agent_instruction response property's maxLength was unset from 1000 for the response status 401
  response-property-max-length-unset
- ▲
  the agent_instruction response property's maxLength was unset from 1000 for the response status 429
  response-property-max-length-unset
- ▲
  the agent_instruction response property's maxLength was unset from 1000 for the response status 500
  response-property-max-length-unset
- ▲
  the message response property's maxLength was unset from 240 for the response status 400
  response-property-max-length-unset
- ▲
  the message response property's maxLength was unset from 240 for the response status 401
  response-property-max-length-unset
- ▲
  the message response property's maxLength was unset from 240 for the response status 429
  response-property-max-length-unset
- ▲
  the message response property's maxLength was unset from 240 for the response status 500
  response-property-max-length-unset
- ▲
  removed the required property deviceCode from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property expiresInSeconds from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property intervalSeconds from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property loginUrl from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property userCode from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property verificationUri from the response with the 200 status
  response-required-property-removed
- ●
  the optional response header Retry-After removed for the status 200
  optional-response-header-removed
- ●
  the optional response header Retry-After removed for the status 400
  optional-response-header-removed
- ●
  the optional response header Retry-After removed for the status 401
  optional-response-header-removed
- ●
  the optional response header Retry-After removed for the status 500
  optional-response-header-removed
- ○
  removed the database_unavailable enum value from the code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the database_unavailable enum value from the code response property for the response status 401
  response-property-enum-value-removed
- ○
  removed the database_unavailable enum value from the code response property for the response status 429
  response-property-enum-value-removed
- ○
  removed the database_unavailable enum value from the code response property for the response status 500
  response-property-enum-value-removed
- ○
  removed the invalid_cpu_limit enum value from the code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the invalid_cpu_limit enum value from the code response property for the response status 401
  response-property-enum-value-removed
- ○
  removed the invalid_cpu_limit enum value from the code response property for the response status 429
  response-property-enum-value-removed
- ○
  removed the invalid_cpu_limit enum value from the code response property for the response status 500
  response-property-enum-value-removed
- ○
  removed the invalid_health_endpoint enum value from the code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the invalid_health_endpoint enum value from the code response property for the response status 401
  response-property-enum-value-removed
- ○
  removed the invalid_health_endpoint enum value from the code response property for the response status 429
  response-property-enum-value-removed
- ○
  removed the invalid_health_endpoint enum value from the code response property for the response status 500
  response-property-enum-value-removed
- ○
  removed the invalid_memory_limit enum value from the code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the invalid_memory_limit enum value from the code response property for the response status 401
  response-property-enum-value-removed
- ○
  removed the invalid_memory_limit enum value from the code response property for the response status 429
  response-property-enum-value-removed
- ○
  removed the invalid_memory_limit enum value from the code response property for the response status 500
  response-property-enum-value-removed
- ○
  removed the invalid_port enum value from the code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the invalid_port enum value from the code response property for the response status 401
  response-property-enum-value-removed
- ○
  removed the invalid_port enum value from the code response property for the response status 429
  response-property-enum-value-removed
- ○
  removed the invalid_port enum value from the code response property for the response status 500
  response-property-enum-value-removed
- ○
  removed the invalid_service_name enum value from the code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the invalid_service_name enum value from the code response property for the response status 401
  response-property-enum-value-removed
- ○
  removed the invalid_service_name enum value from the code response property for the response status 429
  response-property-enum-value-removed
- ○
  removed the invalid_service_name enum value from the code response property for the response status 500
  response-property-enum-value-removed
- ○
  removed the invalid_toml enum value from the code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the invalid_toml enum value from the code response property for the response status 401
  response-property-enum-value-removed
- ○
  removed the invalid_toml enum value from the code response property for the response status 429
  response-property-enum-value-removed
- ○
  removed the invalid_toml enum value from the code response property for the response status 500
  response-property-enum-value-removed
- ○
  removed the missing_command enum value from the code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the missing_command enum value from the code response property for the response status 401
  response-property-enum-value-removed
- ○
  removed the missing_command enum value from the code response property for the response status 429
  response-property-enum-value-removed
- ○
  removed the missing_command enum value from the code response property for the response status 500
  response-property-enum-value-removed
- ○
  removed the missing_config enum value from the code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the missing_config enum value from the code response property for the response status 401
  response-property-enum-value-removed
- ○
  removed the missing_config enum value from the code response property for the response status 429
  response-property-enum-value-removed
- ○
  removed the missing_config enum value from the code response property for the response status 500
  response-property-enum-value-removed
- ○
  removed the missing_source_archive enum value from the code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the missing_source_archive enum value from the code response property for the response status 401
  response-property-enum-value-removed
- ○
  removed the missing_source_archive enum value from the code response property for the response status 429
  response-property-enum-value-removed
- ○
  removed the missing_source_archive enum value from the code response property for the response status 500
  response-property-enum-value-removed
- ○
  removed the payment_required enum value from the code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the payment_required enum value from the code response property for the response status 401
  response-property-enum-value-removed
- ○
  removed the payment_required enum value from the code response property for the response status 429
  response-property-enum-value-removed
- ○
  removed the payment_required enum value from the code response property for the response status 500
  response-property-enum-value-removed
- ○
  removed the policy_rejected enum value from the code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the policy_rejected enum value from the code response property for the response status 401
  response-property-enum-value-removed
- ○
  removed the policy_rejected enum value from the code response property for the response status 429
  response-property-enum-value-removed
- ○
  removed the policy_rejected enum value from the code response property for the response status 500
  response-property-enum-value-removed
- ○
  removed the rate_limited enum value from the code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the rate_limited enum value from the code response property for the response status 401
  response-property-enum-value-removed
- ○
  removed the rate_limited enum value from the code response property for the response status 429
  response-property-enum-value-removed
- ○
  removed the rate_limited enum value from the code response property for the response status 500
  response-property-enum-value-removed
- ○
  response property checkout_url list-of-types was narrowed by removing types null from media type application/json of response 400
  response-property-list-of-types-narrowed
- ○
  response property checkout_url list-of-types was narrowed by removing types null from media type application/json of response 401
  response-property-list-of-types-narrowed
- ○
  response property checkout_url list-of-types was narrowed by removing types null from media type application/json of response 429
  response-property-list-of-types-narrowed
- ○
  response property checkout_url list-of-types was narrowed by removing types null from media type application/json of response 500
  response-property-list-of-types-narrowed
- ○
  response property docs_url list-of-types was narrowed by removing types null from media type application/json of response 400
  response-property-list-of-types-narrowed
- ○
  response property docs_url list-of-types was narrowed by removing types null from media type application/json of response 401
  response-property-list-of-types-narrowed
- ○
  response property docs_url list-of-types was narrowed by removing types null from media type application/json of response 429
  response-property-list-of-types-narrowed
- ○
  response property docs_url list-of-types was narrowed by removing types null from media type application/json of response 500
  response-property-list-of-types-narrowed
- ○
  the code response's property pattern ^[\s\S]{0,8192}$ was added for the status 400
  response-property-pattern-added
- ○
  the code response's property pattern ^[\s\S]{0,8192}$ was added for the status 401
  response-property-pattern-added
- ○
  the code response's property pattern ^[\s\S]{0,8192}$ was added for the status 429
  response-property-pattern-added
- ○
  the code response's property pattern ^[\s\S]{0,8192}$ was added for the status 500
  response-property-pattern-added
- ○
  the agent_instruction response's property pattern was changed from ^[\s\S]{1,1000}$ to ^[\s\S]{0,8192}$ for the status 400
  response-property-pattern-changed
- ○
  the agent_instruction response's property pattern was changed from ^[\s\S]{1,1000}$ to ^[\s\S]{0,8192}$ for the status 401
  response-property-pattern-changed
- ○
  the agent_instruction response's property pattern was changed from ^[\s\S]{1,1000}$ to ^[\s\S]{0,8192}$ for the status 429
  response-property-pattern-changed
- ○
  the agent_instruction response's property pattern was changed from ^[\s\S]{1,1000}$ to ^[\s\S]{0,8192}$ for the status 500
  response-property-pattern-changed
- ○
  the message response's property pattern was changed from ^[\s\S]{1,240}$ to ^[\s\S]{0,8192}$ for the status 400
  response-property-pattern-changed
- ○
  the message response's property pattern was changed from ^[\s\S]{1,240}$ to ^[\s\S]{0,8192}$ for the status 401
  response-property-pattern-changed
- ○
  the message response's property pattern was changed from ^[\s\S]{1,240}$ to ^[\s\S]{0,8192}$ for the status 429
  response-property-pattern-changed
- ○
  the message response's property pattern was changed from ^[\s\S]{1,240}$ to ^[\s\S]{0,8192}$ for the status 500
  response-property-pattern-changed
- ○
  added the required property device_code to the response with the 200 status
  response-required-property-added
- ○
  added the required property expires_in to the response with the 200 status
  response-required-property-added
- ○
  added the required property interval to the response with the 200 status
  response-required-property-added
- ○
  added the required property verification_uri to the response with the 200 status
  response-required-property-added
This revision also has 141 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history