Siebel CRM Desktop for Microsoft Outlook Administration Guide > Customizing Authentication > CRM Desktop SSO Objects You Can Customize >

Credentials Object

The credentials object is a subobject of a request object that specifies the HTTP authorization parameters that CRM Desktop SSO uses. It includes the following functions:

• get_username. Gets the user name associated with a request.
• get_password. Gets the password associated with a request.
• get_auth_schemes. Gets the list of authorization schemes that this request supports, in order of preference. For a list of schemes, see Set Authorization Schemes Function.

Set User Name Function

The set_username function sets the user name for a request. It uses the following format:

set_username(username)

where:

• username is a string that contains the user name.

Set Password Function

The set_password function sets the password for a request. It uses the following format:

set_password(password)

where:

• password is a string that contains the password.

Set Authorization Schemes Function

The set_auth_schemes function sets the authorization schemes that CRM Desktop SSO uses with a request. It uses the following format:

set_auth_schemes(auth_schemes)

where:

• Åauth_schemes is a string that contains the authorization schemes. It can contain any combination of the following values:
  • B, b. Specifies to use basic authorization.
  • N, n. Specifies to use NTLM (NT LAN Manager) authorization.
  • P, p. Specifies to use passport authorization.
  • D, d. Specifies to use digest authorization.

You must use the following format:

• The order that you use is important. For example, if you specify NB, then this request only supports NTLM or basic authentication and it uses NTLM first, if possible.
• JavaScript requires that you use double quotes to enclose each string.
• Values are not case-sensitive.

For example, the following code configures the HTTP client to use NTLM basic authentication if the direct request fails, where NTLM authentication takes priority over basic authentication:

req.get_credentials().set_auth_schemes("nb");

For information about basic authorization and passport authorization, see the topic about HTTP authentication schemes at the Microsoft Developer Network website.