# post\_\_auth\_github

`POST /auth/github`

*GitHub OAuth Authentication*

Authenticate user with GitHub OAuth authorization code.

This endpoint handles GitHub OAuth authentication, similar to Google OAuth but using GitHub's OAuth flow. The system creates or updates user accounts based on GitHub profile information.

**GitHub OAuth Flow:**

1. Redirect user to GitHub OAuth consent screen
2. User authorizes your application
3. GitHub returns authorization code
4. Call this endpoint with the code
5. Receive authentication state with user info and tokens

**Account Creation:**

* Organization name derived from GitHub username or company
* Email from GitHub profile
* Profile image from GitHub avatar

#### TypeScript Client Library

```typescript
private authenticateGithub = async (data: AuthTypes.GithubLoginRequest): Promise<any> => {
  this.setAuthToken(data.code);
  return this.makeRequest<any>('auth/github', 'POST', data);
};
```

#### Code Samples

{% tabs %}
{% tab title="Shell" %}

```shell
# You can also use wget
curl -X POST https://backend.flashback.tech/auth/github \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'
```

{% endtab %}

{% tab title="HTTP" %}

```http
POST https://backend.flashback.tech/auth/github HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Accept: application/json
```

{% endtab %}

{% tab title="JavaScript" %}

```javascript
const inputBody = '{
  "code": "abc123def456..."
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://backend.flashback.tech/auth/github',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
```

{% endtab %}

{% tab title="Ruby" %}

```ruby
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://backend.flashback.tech/auth/github',
  params: {
  }, headers: headers

p JSON.parse(result)
```

{% endtab %}

{% tab title="Python" %}

```python
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://backend.flashback.tech/auth/github', headers = headers)

print(r.json())
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://backend.flashback.tech/auth/github', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
```

{% endtab %}

{% tab title="Java" %}

```java
URL obj = new URL("https://backend.flashback.tech/auth/github");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
```

{% endtab %}

{% tab title="Go" %}

```go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://backend.flashback.tech/auth/github", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
```

{% endtab %}
{% endtabs %}

> Body parameter

```json
{
  "code": "abc123def456..."
}
```

**Parameters**

| Name   | In   | Type   | Required | Description                                         |
| ------ | ---- | ------ | -------- | --------------------------------------------------- |
| body   | body | object | true     | none                                                |
| » code | body | string | true     | GitHub authorization code from OAuth consent screen |

> Example responses

> 200 Response

```json
{
  "success": true,
  "message": "Authentication successful",
  "authState": {
    "user": {
      "email": "user@example.com",
      "name": "John Doe",
      "imageUrl": "https://avatars.githubusercontent.com/u/1234567"
    },
    "token": "string",
    "accessToken": "string",
    "refreshToken": "string",
    "expiresAt": 0,
    "provider": "GITHUB"
  }
}
```

**Responses**

| Status | Meaning                                                 | Description               | Schema |
| ------ | ------------------------------------------------------- | ------------------------- | ------ |
| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Authentication successful | Inline |

**Response Schema**

Status Code **200**

| Name            | Type    | Required | Restrictions | Description                              |
| --------------- | ------- | -------- | ------------ | ---------------------------------------- |
| » success       | boolean | false    | none         | none                                     |
| » message       | string  | false    | none         | none                                     |
| » authState     | object  | false    | none         | none                                     |
| »» user         | object  | false    | none         | none                                     |
| »»» email       | string  | false    | none         | User's email from GitHub                 |
| »»» name        | string  | false    | none         | User's display name from GitHub          |
| »»» imageUrl    | string  | false    | none         | User's profile image URL from GitHub     |
| »» token        | string  | false    | none         | JWT access token for API authentication  |
| »» accessToken  | string  | false    | none         | GitHub access token for GitHub API calls |
| »» refreshToken | string  | false    | none         | GitHub refresh token                     |
| »» expiresAt    | integer | false    | none         | Token expiration timestamp               |
| »» provider     | string  | false    | none         | Authentication provider                  |

**Enumerated Values**

| Property | Value  |
| -------- | ------ |
| provider | GITHUB |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.flashback.tech/support-reference/platform-api-reference/authentication/post__auth_github.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.