Start device authorization

POST

/device/authorizations

Code sample: Shell / cURL

curl --request POST \
  --url https://api.grepvine.ai/v1/device/authorizations \
  --header 'Content-Type: application/json' \
  --data '{ "api_key_name": "example" }'

Request Body^required

Media typeapplication/json

object

api_key_name

required

string

>= 1 characters <= 128 characters

Example ^generated

{
  "api_key_name": "example"
}

Responses

200

The device authorization was created.

Media typeapplication/json

object

device_code

required

string

user_code

required

string

verification_uri

required

string format: uri

verification_uri_complete

required

string format: uri

expires_in

required

integer

>= 1

interval

required

integer

>= 5

Example ^generated

{
  "device_code": "example",
  "user_code": "example",
  "verification_uri": "https://example.com",
  "verification_uri_complete": "https://example.com",
  "expires_in": 1,
  "interval": 1
}

default

The request failed. A 429 carries Retry-After; the index is busy absorbing recent writes or is out of request capacity, and clients must slow down and retry after the interval. A 403 with code organization_suspended refuses every operation on a suspended organization’s members, indexes, documents and searches; reading the organization itself still answers and reports suspended, and the client should contact support.

Media typeapplication/json

object

code

required

string

reason

required

string

error

required

string

Example ^generated

{
  "code": "example",
  "reason": "example",
  "error": "example"
}

Headers

X-Request-Id

string

The request identifier used for support and audit correlation.

Retry-After

integer

Seconds to wait before retrying. Sent with every 429 so a client slows down instead of failing.