Querying Authentication-based Login Modes

Queries the configuration of an authentication-based login mode.

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

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, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:authConfigs:get	Read	-	-	-	-

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 type. 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; SAML2: SAML 2.0 authentication.

None

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	String	Authentication configuration ID.
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.
is_multi_domain_authenticate_enabled	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.
saml2_auth_config	Saml2AuthConfig object	SAML 2.0 authentication configuration information.

**Table 4** 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 5** 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 8** 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.

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

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

Status code: 400

**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: 401

**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: 403

**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: 404

**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.

Status code: 500

**Table 15** 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.

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

Status code: 200

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

{
  "enable" : true
}

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 about the error code, see the error code description.