Skip to content
Changeset Second Opinion

Start a reviewer session with an invite code

POST
/api/v1/auth/login
curl --request POST \
  --url https://example.com/api/v1/auth/login \
  --header 'Content-Type: application/json' \
  --data '{ "display_name": "example", "invite_code": "example" }'

Exchange an invite code and a display name for a session cookie.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
LoginRequest

Invite-code login for a reviewer session.

object
display_name
required
Display Name
string
>= 1 characters <= 80 characters
invite_code
required
Invite Code
string
>= 1 characters <= 128 characters

Example generated

{
  "display_name": "example",
  "invite_code": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
LoginResponse

Result of a login; the session itself travels in the cso_session cookie.

object
me
required
MeResponse

Identity of the caller and the runtime mode.

object
can_claim
Can Claim
boolean
display_name
Any of:
string
id
required
Id
string
mode
required
Mode
string
Allowed values: replay live
osm_signin
Osm Signin
boolean
role
required
Role

Authorization level of the caller, ordered viewer < reviewer < admin.

string
Allowed values: viewer reviewer admin
via_osm
Via Osm
boolean

Example 

{
  "me": {
    "can_claim": false,
    "mode": "replay",
    "osm_signin": false,
    "role": "viewer",
    "via_osm": false
  }
}

401

Section titled “401”

Unauthorized

Problem

Application/problem+json body. Extension members (for example job_id) are allowed.

object
detail
Any of:
string
errors
Any of:
Array<object>
FieldError

One validation failure: where, what, and a stable machine code (never the input value).

object
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
instance
Any of:
string
request_id
required
Request Id
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
key
additional properties
any

Example 

{
  "type": "about:blank"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}

429

Section titled “429”

Too Many Requests

Problem

Application/problem+json body. Extension members (for example job_id) are allowed.

object
detail
Any of:
string
errors
Any of:
Array<object>
FieldError

One validation failure: where, what, and a stable machine code (never the input value).

object
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
instance
Any of:
string
request_id
required
Request Id
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
key
additional properties
any

Example 

{
  "type": "about:blank"
}

Map data © OpenStreetMap contributors, under the Open Database Licence. Code under the Apache-2.0 licence. Made by Yogesh.

Changeset Second Opinion is an independent open source tool for OpenStreetMap reviewers. It is not endorsed by, sponsored by or affiliated with the OpenStreetMap Foundation. OpenStreetMap is a trademark of the OpenStreetMap Foundation, used under itstrademark policy.