Get the sign-in options

GET

/auth/options

Code sample: Shell / cURL

curl --request GET \
  --url https://api.grepvine.ai/v1/auth/options

How accounts are created on this service. The console reads it to decide whether to offer registration without an invitation.

Responses

200

The sign-in options.

Media typeapplication/json

object

signup

required

How accounts are created. open lets anyone register; invite registers only with an invitation.

string

Allowed values: open invite

Example

{
  "signup": "open"
}

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.