SQL Admin Provider::AddLogin

  • Article

The AddLogin method allows you to create a standard SQL user account.

Arguments

Input argument Required Description

Name

Yes

The standard SQL Server login name, allowing up to 128 characters, including letters, symbols, and numbers. The name cannot contain an empty string, backslash "\," NULL value, or reserved login name (for example, sa or public).

Password

Yes

The password to set for the SQL user account.

ServerName

Yes

A string representing the name of the server. This can be a NetBIOS name, a FQDN, or an IP address. It is vital that the server upon which MPS is running be able to resolve server names using whichever naming convention you employ.

[defaultDB]

No

The default database.

[sqlUserName]

No

The user name for connecting to the SQL server via SQL Authentication. If this node is present, the connection will be made via SQL Authentication rather than Windows Authentication. The existence of this node also requires that the <sqlUserPass/> node exist.

[sqlUserPass]

No

The password for connecting to the SQL server via SQL Authentication using the username indicated by <sqlUserName/>. If the <sqlUserName/> node is not present, this node is ignored.

Remarks

Rollback Calls

On transaction rollback, the DropLogin method is called.

Sample Code

Example XML Request

The following is an example of an XML request for the AddLogin method:

<?xml version="1.0" encoding="iso-8859-1" ?>  
<request> 
    <data> 
        <name>SampleDBUser</name> 
        <password>password</password> 
        <defaultDB></defaultDB> 
        <serverName>SQL01</serverName> 
        <sqlUserName>sampleUser</sqlUserName> 
        <sqlUserPass>Pass1Word</sqlUserPass> 
    </data> 
    <procedure> 
        <execute namespace="SQL Admin Provider" procedure="AddLogin"> 
        <before source="data" destination="executeData" mode="merge"/> 
        <before source="executeData" destination="data" mode="insert"/> 
        </execute> 
    </procedure> 
</request>

Example XML Response

The following is an example of the structure of an XML response for the AddLogin method. The actual returned data will be filled in within the <data> nodes:

<?xml version="1.0" encoding="iso-8859-1" ?>  
<response> 
    <data></data> 
</response>

Applies To

for:

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

  • Hosted Messaging and Collaboration version 3.5

  • Hosted Messaging and Collaboration version 3.0

  • Windows-based Hosting version 4.5

  • Windows-based Hosting version 4.0

  • Windows-based Hosting version 3.5

  • Windows-based Hosting for Applications version 1.0

See also

Tasks

SQL Admin Provider::GrantLogin
SQL Admin Provider::DropLogin
SQL Admin Provider::RevokeLogin