Auth

Description

The Auth type supplies credentials and optionally, a host name for licensing. The Auth type parameters are listed below.

Parameters

Name	Type	Description
userId	string	The SBM user Login ID. If you are only specifying the host name, then userId is optional.
password	string	The password for the user. If you are only specifying the host name, then password is optional.
hostname	string	The host name of the client.
loginAsUserId	string	User ID for the SBM login you wish to impersonate. If you are only specifying the host name, then loginAsUserId is optional.
extendedData	ExtendedData	Placeholder for future arguments.

Usage

The Auth type allows credentials to be provided if not using WS-SECURITY or HTTP BASIC to pass the credentials. The hostname element is only needed in case you want to override the client's IP address for licensing purposes, forcing License Manager to use a particular client host. If it is not provided, the code gets the client hostname from the socket.

Note: The loginAsUserId parameter requires that the calling user is either a Global Managed Administrator or a Managed Administrator with Admin privileges to one of the groups which the user to be impersonated belongs.

XML

The following XML shows Auth as seen in a typical call.

<urn:auth>
    <urn:userId>admin</urn:userId>
    <urn:password>password</urn:password>
    <urn:hostname>serverName</urn:hostname>
    <urn:loginAsUserId></urn:loginAsUserId>
    <urn:extendedData></urn:extendedData>
</urn:auth>