Resolve a GitHub user for private-site access

GET

/sites/{site_name}/access/github-users/{github_login}

curl --request GET \
  --url https://example.com/sites/example/access/github-users/example \
  --header 'Authorization: Bearer <token>'

Authorizations

• BearerAuth

Parameters

Path Parameters

site_name

required

Site Name

string

github_login

required

Github Login

string

Responses

200

Successful Response

Media typeapplication/json

GitHubUserResponse

object

avatar_url

required

Any of:

string

string

null

null

github_id

required

Github Id

integer

github_login

required

Github Login

string

github_name

required

Any of:

string

string

null

null

Example^generated

{
  "avatar_url": "example",
  "github_id": 1,
  "github_login": "example",
  "github_name": "example"
}

400

The GitHub username is invalid.

Media typeapplication/json

ErrorResponse

object

detail

required

Detail

string

Example^generated

{
  "detail": "example"
}

401

Authentication is required.

Media typeapplication/json

ErrorResponse

object

detail

required

Detail

string

Example^generated

{
  "detail": "example"
}

403

Site ownership is required.

Media typeapplication/json

ErrorResponse

object

detail

required

Detail

string

Example^generated

{
  "detail": "example"
}

404

The site or GitHub user was not found.

Media typeapplication/json

ErrorResponse

object

detail

required

Detail

string

Example^generated

{
  "detail": "example"
}

409

The site is not private.

Media typeapplication/json

ErrorResponse

object

detail

required

Detail

string

Example^generated

{
  "detail": "example"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

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

502

GitHub lookup failed.

Media typeapplication/json

ErrorResponse

object

detail

required

Detail

string

Example^generated

{
  "detail": "example"
}