Help Center/ Workspace/ API Reference/ Workspace APIs/ Tenant Configuration/ Verifying Configurations (Only for SAML 2.0 Configurations)

Updated on 2026-02-10 GMT+08:00

View PDF

Verifying Configurations (Only for SAML 2.0 Configurations)

Function

Verifies whether configurations are valid. Only SAML 2.0 configurations can be verified.

Debugging

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v2/{project_id}/auth-config/validate-config

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
id	No	String	Authentication configuration ID.
is_multi_domain_authenticate_enabled	No	Boolean	Whether multiple domains are supported.
auth_type	No	String	Authentication type. RADIUS_GATEWAY: SMS auxiliary authentication OAUTH2: OAuth 2.0 authentication CLIENT_TOKEN: local token authentication USER_PASSWORD: password authentication SAML2: SAML 2.0 federated authentication
radius_gateway_config	No	RadiusGatewayConfig object	SMS auxiliary authentication configuration.
third_party_auth_config	No	ThirdPartyAuthConfig object	Third-party authentication configuration information.
emergency_login_mode	No	String	Emergency login mode.
saml2_auth_config	No	Saml2AuthConfig object	SAML 2.0 authentication configuration information.

**Table 3** RadiusGatewayConfig
Parameter	Mandatory	Type	Description
enable	No	Boolean	Enabled or not.
app_id	No	String	Username.
password	No	String	Password.
token_url	No	String	URL for obtaining the token.
verification_cipher_url	No	String	URL for obtaining the verification code.
cert_content	No	String	Certificate content (PEM).

**Table 4** ThirdPartyAuthConfig
Parameter	Mandatory	Type	Description
update_type	No	String	Updates the authentication configuration type. This parameter is used when the authentication type is third-party SSO authentication.
enable	No	Boolean	Enabled or not.
update_object	No	String	Updates the object that uses the authentication configuration. This parameter is used when the authentication type is third-party SSO authentication.
auth_type	No	String	Authentication type.
client_interface_config	No	InterfacesConfig object	Interface configuration.
server_interface_config	No	InterfacesConfig object	Interface configuration.
third_password_update_type	No	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	No	String	Custom interface configuration.
oauth_configs	No	String	OAuth 2.0 configuration.
ldap_configs	No	Array of LdapConfig objects	SSO configuration information list.
third_password_name	No	String	Updates the object that uses the authentication configuration. This parameter is used when the authentication type is third-party password authentication.

**Table 5** InterfacesConfig
Parameter	Mandatory	Type	Description
apply_platform	No	String	Application platform.
id	No	String	ID.
name	No	String	Name.
type	No	String	Type.
results	No	Map<String,String>	Result.
pagination	No	Map<String,Object>	Pagination information.
request	No	InterfacesRequest object	API Request.
response	No	String	Response.
result_check	No	String	Check result.

**Table 6** InterfacesRequest
Parameter	Mandatory	Type	Description
method	No	String	Method.
params	No	Map<String,String>	Request parameter.
headers	No	Map<String,String>	Request header information.
body	No	String	Request body.
url	No	String	URL.
configs	No	Map<String,Object>	Configuration.

**Table 7** LdapConfig
Parameter	Mandatory	Type	Description
host	No	String	Host.
port	No	Integer	Port number. The value ranges from 1 to 65535. The default value is 389.
base_dn	No	String	base_dn.
administrator_dn	No	String	Administrator DN.
administrator_password	No	String	Administrator password.
user_dn	No	String	User DN.
use_ssl	No	Boolean	Whether to enable SSL.
cert_content	No	String	Certificate.
username_attribute	No	String	Username attribute.
object_class	No	String	User object class.
security_type	No	String	Security type.

**Table 8** Saml2AuthConfig
Parameter	Mandatory	Type	Description
identity_provider	No	String	Identity provider name.
access_server_address	No	String	Access server address.
unique_user_identifier	No	String	Unique user identifier.
idp_metadata_info	No	IdpMetadataInfo object	Identity provider (IDP) metadata information.

**Table 9** IdpMetadataInfo
Parameter	Mandatory	Type	Description
id	No	String	IDP metadata ID
file_name	No	String	IDP metadata file name.
content	No	String	IDP metadata content (Base64).
content_length	No	Number	Metadata size (in bytes). The maximum size is 1 MB.
create_time	No	Long	Creation timestamp.
update_time	No	Long	Update timestamp.

Response Parameters

Status code: 200

OK.

Status code: 400

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
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 message.
error_detail	String	Error details.
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 message.
error_detail	String	Error details.
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 message.
error_detail	String	Error details.
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 message.
error_detail	String	Error details.
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

{
  "id" : "c6e9d5eef0c7xxxxxxxxxx0303397d1e",
  "is_multi_domain_authenticate_enabled" : true,
  "auth_type" : "RADIUS_GATEWAY",
  "radius_gateway_config" : {
    "enable" : false
  },
  "third_party_auth_config" : {
    "enable" : false
  },
  "emergency_login_mode" : "string",
  "saml2_auth_config" : {
    "identity_provider" : "aa",
    "access_server_address" : "https://xxx.xxx.xxx.xxx",
    "unique_user_identifier" : "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name",
    "idp_metadata_info" : {
      "id" : "000a7711f04xxxxxxxxxxb0733d87421",
      "file_name" : "idp-metadata.xml",
      "content" : "MIIDcjCCAlq...",
      "content_length" : 1024,
      "create_time" : 1741330304,
      "update_time" : 1741256229
    }
  }
}

Example Responses

None

Status Codes

Status Code	Description
200	OK.
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 about the error code, see the error code description.