Help Center> ServiceStage> API Reference> Git Repository Access APIs> Creating Private Token Authorization
Updated on 2023-07-19 GMT+08:00

Creating Private Token Authorization

Function

This API is used to create private token authorization.

URI

POST /v1/{project_id}/git/auths/{repo_type}/personal

Table 1 describes the parameters.

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant's project ID. See Obtaining a Project ID.

repo_type

Yes

String

Repository type.

Value: github, or gitlab.

Request

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type or format.

X-Auth-Token

Yes

String

API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain a token, see Obtaining a User Token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Authorization name.

token

Yes

String

Repository token.

host

No

String

Repository address.

Response

Table 4 Response parameters

Parameter

Type

Description

authorization

Object

Authorization structure. See Table 5.

Table 5 authorization parameters

Parameter

Type

Description

name

String

Authorization name.

repo_type

String

Repository type.

Value: github, or gitlab.

repo_host

String

Repository address.

repo_home

String

Repository homepage.

repo_user

String

Repository username.

avartar

String

Repository avatar.

token_type

String

Repository authorization type.

create_time

Long

Repository authorization creation timestamp.

update_time

Long

Repository authorization update timestamp.

status

Integer

Repository authorization status.

0: normal

1: overdue

2: unauthenticated

Example Request

Create private token authorization token1.

{
  "name": "token1",
  "token": "ghp_7QoYcNLFahSXSbhhuT8R5xHLKe*******6",
  "host": "https://github.com/tom-repo"
}

Example Response

{
    "authorization": {
        "name": "token1",
        "repo_type": "github",
        "repo_host": "https://api.github.com",
        "repo_home": "https://github.com/tom-repo",
        "repo_user": "tom-repo",
        "avartar": "https://avatars.githubusercontent.com/u/73919264?v=4",
        "token_type": "personal",
        "create_time": 1649762172340,
        "update_time": 1649762172340,
        "status": 0
    }
}

Status Code

Table 6 Status codes

HTTP Status Code

Description

200

OK

400

Bad Request

Error Code

The error code format is SVCSTG.REPO.[Error_ID], for example, SVCSTG.REPO.0401. For details, see ServiceStage Error Codes.