OAuth authorizations

1. OAuth Authentication Endpoint

Request

GET https://gitcode.com/oauth/authorize?client_id={client_id}&redirect_uri={redirect_uri}&response_type=code&scope={scope}&state={state}

Parameter	Type	Data Type	Description
client_id*	query	string	The client ID of the GitCode app
redirect_uri*	query	string	redirect url
scope	query	string	scope
state	query	string	State Parameter, Preventing CSRF Attacks

2. Redirection

If the user grants your authorization request, GitCode will redirect back to your specified website, including the code parameter and the state parameter you provided in the previous step.

GET {redirect_uri}?code={code}&state={state}

3. Obtaining an Authorization Token

Once you receive the authorization_code in the redirect URL, you can exchange it for an access token by making a POST request to GitCode’s token endpoint.

POST https://gitcode.com/oauth/token?grant_type=authorization_code&code={code}&client_id={client_id}&client_secret={client_secret}

Parameter	Type	Data Type	Description
grant_type	query	authorization_code	grant_type
code*	query	string	code
client_id*	query	string	The client ID of the GitCode app
client_secret*	formData	string	The secret of the GitCode app

Response

{
    "access_token": "eyPZPVNfsibj9tap_ibj3t3p",
    "expires_in": 1296000,
    "refresh_token": "b77ced3aee884348852160deab3697a1",
    "scope": "all_user all_key all_groups all_projects all_pr all_issue all_note all_hook all_repository",
    "created_at": "2024-04-20T09:07:59.889Z"
}

4. Using an Access Token to Access the User Information API

Authorization: Bearer {access_token}
GET https://api.gitcode.com/api/v5/user

5. Refreshing the Access Token

POST https://gitcode.com/oauth/token?grant_type=refresh_token&refresh_token={refresh_token}