Help Center/ Workspace/ API Reference/ Workspace APIs/ Tenant Configuration/ Updating the Authentication Policy Configuration
Updated on 2025-07-14 GMT+08:00

Updating the Authentication Policy Configuration

Function

Updates the authentication policy configuration.

Debugging

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

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

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

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.

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

Response Parameters

Status code: 200

Table 9 Response body parameters

Parameter

Type

Description

project_id

String

Project ID.

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

PUT /v2/fb2e5ec048384c8f9469d22db0037908/auth-config/method-config

{
  "auth_type" : "RADIUS_GATEWAY",
  "radius_gateway_config" : {
    "enable" : true,
    "app_id" : "sms3d356sd4f1s3e",
    "password" : 123456,
    "token_url" : "www.xxx-token.com",
    "verification_cipher_url" : "www.xxx-sms.com",
    "cert_content" : "cert_content"
  }
}

Example Responses

Status code: 200

Response to the request for updating the authentication policy configuration.

{
  "project_id" : "0e575d8e1a00f4742f70c00589a0ebdc"
}

Status Codes

Status Code

Description

200

Response to the request for updating the authentication policy configuration.

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.