Updated on 2023-07-19 GMT+08:00

Creating Password Authorization

Function

This API is used to create password authorization for a Git repository.

URI

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

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: bitbucket.

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.

user

Yes

String

Repository username.

password

Yes

String

Repository password.

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: bitbucket.

repo_host

String

Repository address.

repo_home

String

Repository homepage.

repo_user

String

Repository username.

avartar

String

Avatar.

token_type

String

Authorization mode.

create_time

Long

Creation time.

update_time

Long

Update time.

status

Integer

Repository authorization status.

0: normal

1: overdue

2: unauthenticated

Example Request

Create password authorization pass1.

{
  "name": "pass1",
  "user": "bucket-ljn",
  "password": "*********"
}

Example Response

{
  "authorization": {
    "name": "pass1",
    "repo_type": "bitbucket",
    "repo_host": "https://api.bitbucket.org",
    "repo_home": "https://bitbucket.org/%7B63cc78de-***********-9505c0335f96%7D/",
    "repo_user": "bucket-ljn",
    "avartar": "https://secure.gravatar.com/avatar/05a7b4a2302750*********cf64?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FB-2.png",
    "token_type": "password",
    "create_time": 1634119075119,
    "update_time": 1634119075119,
    "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.