Creating Private Token Authorization

Function

This API is used to create private token authorization.

Debugging

You can debug this API in API Explorer which supports automatic authentication. API Explorer automatically generates sample SDK code and provides the debug function.

Authorization Information

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the permission listed below is required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
servicestage:repositoryAuth:create	write	repositoryAuth	-	-	-

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 (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 Through Password Authentication.

**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
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
    }
}