All Products
Search
Document Center

Identity as a Service:GetBrand

Last Updated:Oct 20, 2025

Retrieves the details of a brand.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

The instance ID.

idaas_ue2jvisn35ea5lmthk267xxxxx

BrandId

string

Yes

The brand ID.

brand_xxxx

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

0441BD79-92F3-53AA-8657-F8CE4A2B912A

Brand

object

The brand.

InstanceId

string

The instance ID.

idaas_ue2jvisn35ea5lmthk267xxxxx

BrandId

string

The brand ID.

brand_xxxx

BrandName

string

The brand name.

Custom Brand

BrandType

string

The brand type.

Valid values:

  • system_init :

    The brand is initialized by the system.

  • user_custom :

    The brand is customized by the user.

user_custom

Status

string

The brand status.

Valid values:

  • disabled :

    The brand is disabled.

  • enabled :

    The brand is enabled.

enabled

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "Brand": {
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "BrandId": "brand_xxxx",
    "BrandName": "Custom Brand",
    "BrandType": "user_custom",
    "Status": "enabled"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.