Owner's manual

XML Request Data
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:user xmlns:ns2="http://automatedMediaLibrary/">
<name>johnDoe</name>
<password>password</password>
<role>1</role>
<partitionAccess>Partition Name</partitionAccess>
</ns2:user>
XML Response See “URI: aml/users” (page 103) for the XML Response code.
URI: aml/users/login
Method POST
Description Login to the library. A successful login returns a session cookie that need
to be use for successive requests. If a service user is currently logged in
a 503 status code is returned and the login will be denied.
If the maximum number of ADMIN user logins has been exceeded the
customCode element of the WSResultCode will be set to 1.
Media Type Request: application/x-www-form-urlencoded
Response: application/xml and application/json
Parameters The form parameters are name, password, ldap, and forceLogin. The
valid values for each parameter are as follows:
• name—valid user name
• password—the user password
• ldap—“true” or “false”
• forceLogin—“true” or “false”
If you want to use LDAP to authenticate set ldap=true.
The forceLogin parameter only applies to an admin user. This can can
be used when the number of admin logins has exceed the maximum
allowed.
Response Code 200, 401, 500, and 503
Method POST
Description Login to the library using the user XML object. A successful login returns
a session cookie that need to be used for successive requests. If a service
user is currently logged in a 503 status code is returned and the login
will be denied.
Media Type Request: application/xml and application/json
Response: application/xml and application/json
Parameters The query parameters forceLogin. The valid values for each parameter
are as follows:
• forceLogin—“true” or “false”
The forceLogin parameter only applies to an admin user. This can be
used when the number of admin logins has exceeded the maximum
allowed. If used it will force one of the current logged admins to be
logged out.
If the maximum number of ADMIN user logins has been exceeded the
customCode element of the WSResultCode will be set to 1.
Response Code 200, 401, 500, and 503
URI: aml/users/login 53