Name a GitHub account

POST

/api/v1/github-orgs

curl --request POST \
  --url http://localhost:3000/api/v1/github-orgs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "login": "example" }'

A GitHub organization (or account) of the organization’s. Put the file in file in its .github repository, holding file.token, then POST /api/v1/github-orgs/{login}/verify. Once proved, the organization’s BrandHub listings are verified, as github.com/{login}, like a verified domain.

Scope: admin.

Authorizations

• bearer
• session
• None

Request Body^required

Media typeapplication/json

object

login

required

A GitHub account of the organization’s: rust-lang, or https://github.com/rust-lang

string

>= 1 characters <= 100 characters

Example^generated

{
  "login": "example"
}

Responses

201

The account, not verified yet

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"
  }
}