Help Center/ IAM Identity Center/ API Reference/ API/ Instance Management/ Setting a Custom Portal URL
Updated on 2025-08-21 GMT+08:00
View PDF
Share

Setting a Custom Portal URL

Function

This API is used to set a custom portal URL. The default URL format is idcenter.huaweicloud.com/d-xxxxxxxxxx/portal. You can change it to idcenter.huaweicloud.com/your_subdomain/portal. Setting a custom portal URL is a one-time operation and cannot be undone. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

POST /v1/instances/{instance_id}/alias

Table 1 Path parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Globally unique ID of an IAM Identity Center instance.

Request Parameters

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.
Table 3 Parameters in the request body

Parameter

Mandatory

Type

Description

alias

Yes

String

Alias of the user-defined identity source ID.

Response Parameters

Status code: 200

Successful

Status code: 400

Table 4 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

Status code: 403

Table 5 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

encoded_authorization_message

String

Encrypted error message.

Status code: 409

Table 6 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

Example Request

Setting a custom portal URL. The default URL format is idcenter.huaweicloud.com/d-xxxxxxxxxx/portal. You can change it to idcenter.huaweicloud.com/your_subdomain/portal. Setting a custom portal URL is a one-time operation and cannot be undone.

POST https://{hostname}/v1/instances/{instance_id}/alias

{
  "alias" : "mycimpany"
}

Example Response

None

Status Codes

Status Code

Description

200

Successful

400

Bad request.

403

Forbidden.

409

Conflict.

Error Codes

For details, see Error Codes.

Parent topic: Instance Management