Help Center/ Workspace/ API Reference/ Workspace APIs/ Tenant Configuration/ Querying Authentication-based Login Modes
Updated on 2025-07-14 GMT+08:00

Querying Authentication-based Login Modes

Function

Queries the configuration of an authentication-based login mode.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v2/{project_id}/auth-config/method-config

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

auth_type

No

String

Authentication method. LOCAL_PASSWORD: local password authentication; KERBEROS: Windows AD authentication; LDAP: third-party LDAP authentication; CLIENT_TOKEN: token authentication of the Golden Auditing UKEY client; OAUTH2: third-party SSO authentication

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Content-Type

Yes

String

MIME type of the request body.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

auth_type

String

Authentication type.

LOCAL_PASSWORD: local password authentication

KERBEROS: Windows AD authentication

LDAP: third-party LDAP authentication

CLIENT_TOKEN: Ukey client token authentication

OAUTH2: third-party SSO authentication

enable

Boolean

Status.

radius_gateway_config

RadiusGatewayConfigInfo object

SMS auxiliary authentication configuration.

third_party_auth_config

Array of ThirdPartyAuthConfig objects

Third-party authentication API configuration information.

emergency_login_mode

String

Emergency login mode.

Table 5 RadiusGatewayConfigInfo

Parameter

Type

Description

enable

Boolean

Enabled or not.

app_id

String

Username.

cert_domain_name

String

Certificate domain name.

token_url

String

URL for obtaining the token.

verification_cipher_url

String

URL for obtaining the verification code.

auth_type

String

Authentication type.

assist_auth_type

String

Auxiliary authentication type.

expiration

String

Expiration time.

Table 6 ThirdPartyAuthConfig

Parameter

Type

Description

update_type

String

Updates the authentication configuration type. This parameter is used when the authentication type is third-party SSO authentication.

enable

Boolean

Enabled or not.

update_object

String

Updates the object that uses the authentication configuration. This parameter is used when the authentication type is third-party SSO authentication.

auth_type

String

Authentication type.

client_interface_config

InterfacesConfig object

Interface configuration.

server_interface_config

InterfacesConfig object

Interface configuration.

third_password_update_type

String

Updates the authentication configuration type. This parameter is used when the authentication type is third-party password authentication. ADD: adding; UPDATE: modifying; DELETE: deleting

custom_definition

String

Custom interface configuration.

oauth_configs

String

OAuth 2.0 configuration.

ldap_configs

Array of LdapConfig objects

SSO configuration information list.

third_password_name

String

Updates the object that uses the authentication configuration. This parameter is used when the authentication type is third-party password authentication.

Table 7 InterfacesConfig

Parameter

Type

Description

apply_platform

String

Application platform.

id

String

ID.

name

String

Name.

type

String

Type.

results

Map<String,String>

Result.

pagination

Map<String,Object>

Pagination information.

request

InterfacesRequest object

API Request.

response

String

Response.

result_check

String

Check result.

Table 8 InterfacesRequest

Parameter

Type

Description

method

String

Method.

params

Map<String,String>

Request parameter.

headers

Map<String,String>

Request header information.

body

String

Request body.

url

String

URL.

configs

Map<String,Object>

Configuration.

Table 9 LdapConfig

Parameter

Type

Description

host

String

Host.

port

Integer

Port number. The value ranges from 1 to 65535. The default value is 389.

base_dn

String

base_dn.

administrator_dn

String

Administrator DN.

administrator_password

String

Administrator password.

user_dn

String

User DN.

use_ssl

Boolean

Whether to enable SSL.

cert_content

String

Certificate.

username_attribute

String

Username attribute.

object_class

String

User object class.

security_type

String

Security type.

Status code: 400

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

Table 14 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

GET /v2/29dfe82ada564ac2b927e1ff036d9a9b/auth-config/method-config

Example Responses

Status code: 200

Response to the request for querying authentication-based login modes.

{
  "enable" : true
}

Status Codes

Status Code

Description

200

Response to the request for querying authentication-based login modes.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

No operation permissions.

404

No resources found.

500

An internal service error occurred. For details, see the error code description.

Error Codes

See Error Codes.