Verify a GitHub account

POST

/api/v1/github-orgs/{login}/verify

curl --request POST \
  --url http://localhost:3000/api/v1/github-orgs/example/verify \
  --header 'Authorization: Bearer <token>'

Reads the proof file from the account’s .github repository, on its default branch, now; a 422 says what is missing.

Scope: admin.

Authorizations

• bearer
• session
• None

Parameters

Path Parameters

login

required

string

E.g. rust-lang

Responses

200

The account

Media typeapplication/json

object

data

required

object

login

required

string

verified

required

Proved: its listings on BrandHub are verified, as github.com/{login}

boolean

url

required

string format: uri

file

required

What proves it: a file at path in the account’s .github repository, on its default branch, holding token

object

repository

required

string

path

required

string

url

required

string format: uri

token

required

string

Example^generated

{
  "data": {
    "login": "example",
    "verified": true,
    "url": "https://example.com",
    "file": {
      "repository": "example",
      "path": "example",
      "url": "https://example.com",
      "token": "example"
    }
  }
}

default

An error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

detail

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}