Help Center/ ServiceStage/ API Reference/ Git Repository Access APIs/ Obtaining a Git Repository Authorization List
Updated on 2024-10-16 GMT+08:00

Obtaining a Git Repository Authorization List

Function

This API is used to obtain a Git repository authorization list.

URI

GET /v1/{project_id}/git/auths

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.

Request

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format). Default value: application/json;charset=utf8.

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.

Response

Table 3 Response parameters

Parameter

Type

Description

authorizations

Array<Object>

Authorization structure. See Table 4.

count

Integer

Number of authorized repositories.

Table 4 authorizations

Parameter

Type

Description

name

String

Authorized repository.

repo_type

String

Repository type.

Value: GitHub, BitBucket, 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

tag

String

Type of the authorized environment. Default value: null.

Example Request

None

Example Response

{
  "authorizations": [
    {
      "name": "test",
      "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/73919200?v=4",
      "token_type": "oauth",
      "create_time": 1649731565642,
      "update_time": 1649731565642,
      "tag": null,
      "status": 0
    }
  ],
  "count": 1  
}

Status Code

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.