All Products
Search

This Product

    Bastionhost:ModifyInstanceLDAPAuthServer

    Document Center

    Bastionhost:ModifyInstanceLDAPAuthServer

    Last Updated:Jan 12, 2023

    Modifies the settings of Lightweight Directory Access Protocol (LDAP) authentication on a bastion host.

    Authorization information

    The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
    • Condition keyword: refers to the condition keyword defined by the cloud product itself.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    Operate access level Resource type conditional keyword Association operation
    yundun-bastionhost:ModifyInstanceLDAPAuthServer Write
      All resources
      without
    		without

    Request parameters

    Parameter Type Required Description Example
    InstanceId string Yes

    The ID of the bastion host. You can call the DescribeInstances operation to query the ID of the bastion host.

    		 bastionhost-cn-st220aw****
    RegionId string No

    The region ID of the bastion host. For more information about the mapping between region IDs and region names, see Regions and zones.

    		 cn-hangzhou
    Server string No

    The address of the LDAP server.

    		 192.168.XX.XX
    StandbyServer string No

    The address of the secondary LDAP server.

    		 192.168.XX.XX
    Port string No

    The port that is used to access the LDAP server.

    		 389
    IsSSL string No

    Specifies whether to support SSL. Valid values:

    • true: supports SSL.
    • false: does not support SSL.
    		 true
    BaseDN string No

    The Base distinguished name (DN).

    		 dc=test,dc=com
    Account string No

    The username of the account that is used for the LDAP server.

    		 cn=Manager,dc=test,dc=com
    Password string No

    The password of the account that is used for the LDAP server.

    		 ******
    Filter string No

    The condition that is used to filter users.

    		 (objectClass=top)
    LoginNameMapping string No

    The field that is used to indicate the logon name of a user on the LDAP server.

    		 userNameAttr
    NameMapping string No

    The field that is used to indicate the name of a user on the LDAP server.

    		 nameAttr
    EmailMapping string No

    The field that is used to indicate the email address of a user on the LDAP server.

    		 emailAttr
    MobileMapping string No

    The field that is used to indicate the mobile phone number of a user on the LDAP server.

    		 mobileAttr

    Response parameters

    Parameter Type Description Example
    object

    Schema of Response
    RequestId string

    The ID of the request, which is used to locate and troubleshoot issues.

    		 8F1085E3-F048-5F34-B650-F145216E4AA4

    Example

    Normal return example

    JSONFormat

    {
  "RequestId": "8F1085E3-F048-5F34-B650-F145216E4AA4"
}

    Error codes

    Http code Error code Error message
    400 InvalidParameter The argument is invalid.
    500 InternalError An unknown error occurred.

    For a list of error codes, visit the API error center.