Help Center/ CodeArts Build/ API Reference/ APIs/ Tenant Management/ Checking If the Account Is Federated
Updated on 2025-08-21 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Checking If the Account Is Federated

Function

This API is used to check if an account is a federated account.

Calling Method

For details, see Calling APIs.

URI

GET /v1/domain/federation

Request Parameters

None

Response Parameters

Status code: 200

Table 1 Response body parameters

Parameter

Type

Description

result

Boolean

Whether the account is federated.

error

String

Definition

Returned error message.

Range

N/A.

status

String

Definition

Returned status information.

Range

● success: The API call is successful.

● fail: The API call failed.

Status code: 400

Table 2 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

GET https://{endpoint}/v1/domain/federation

Example Responses

Status code: 200

OK

{
  "result" : false,
  "error" : null,
  "status" : "success"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent Topic: Tenant Management