GetMemberHttpsCloneUsername - Query a user's clone username
Retrieves a user's HTTPS clone username.
|
Applicable editions |
Central edition, Region edition |
Endpoint and authorization information
-
Obtain the endpoint. Replace {domain} in the API request syntax.
-
Obtain the organizationId. Required only for the Central edition. Go to the Basic Information page in the Organization Management console to obtain the organization ID.
|
Product |
Resource |
Required permission |
|
Code Management |
Member |
Read-only |
Request syntax
Central edition
GET https://{domain}/oapi/v1/codeup/organizations/{organizationId}/users/{userId}/httpsCloneUsername
Region edition
GET https://{domain}/oapi/v1/codeup/users/{userId}/httpsCloneUsername
Request headers
|
Parameter |
Type |
Required |
Description |
Example |
|
x-yunxiao-token |
string |
Yes |
A personal access token. |
pt-0fh3****0fbG_35af****0484 |
Request parameters
|
Parameter |
Type |
Location |
Required |
Description |
Example |
|
organizationId |
string |
path |
|
The organization ID. |
60d54f3daccf2bbd6659f3ad |
|
userId |
string |
path |
Yes |
The user ID. |
62c795xxxb468af8 |
Request examples
Central edition
curl -X 'GET' \
'https://{domain}/oapi/v1/codeup/organizations/60d54f3daccf2bbd6659f3ad/users/62c795xxxb468af8/httpsCloneUsername' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'
Region edition
curl -X 'GET' \
'https://{domain}/oapi/v1/codeup/users/62c795xxxb468af8/httpsCloneUsername' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'
Response parameters
|
Parameter |
Type |
Description |
Example |
| - |
object |
||
|
httpsCloneUsername |
string |
The HTTPS clone username of the user. |
2813489 |
Response example
{
"httpsCloneUsername": "2813489"
}
Error codes
For more information about API error codes, see the Error Code Center.