BlackBerry Administration API

Version: 5.0

Installation Guide

Published: 2009-03-31 SWD-663576-0331024940-001 .

....................................................................................................................................................................................................................................................... 2 2 2 4 4 4 5 6 7 8 2 Creating administrator accounts for your application..................................................................................................... 5 Legal notice................................................................................................................................................................................................................................... Create an administrator account....................................................................................................Contents 1 Installing the BlackBerry Administration API.............................................. 4 Provide feedback................................................................................................................................................................................................................................................. 3 Glossary............................................................................. Create a role......................................... Create a role based on an existing role...................................................................................................... .................... Install the BlackBerry Administration API........................................................................................................................................................................................................................................................ Requirements: BlackBerry Administration API............................

Log in to the computer that hosts the BlackBerry® Enterprise Server using the BESAdmin account that you created when you installed the BlackBerry Enterprise Server . In the BlackBerry Administration API installation media.0 or later with the following settings: • • Java® or JavaScript® turned on language preferences configured to display encoded web pages BlackBerry® Administration Service the version and service pack number of the BlackBerry® Enterprise Server and the BlackBerry Administration Service must match the version and service pack number of the BlackBerry® Administration API you are installing. double-click the setup.msi file. If the DNS settings or load balancing software is properly configured for the BlackBerry Administration Service instances. the BlackBerry Administration API should not require additional network configuration to support high availability. Install the BlackBerry Administration API 1. you can install the BlackBerry Administration API on each computer that hosts an instance of the BlackBerry Administration Service.Installation Guide Installing the BlackBerry Administration API Installing the BlackBerry Administration API 1 The BlackBerry® Administration API provides web services that allow developers to create applications to manage an organization's BlackBerry® Enterprise Server components. You must install the BlackBerry Administration API on the same computer that hosts the BlackBerry Administration Service. If your organization's environment is configured to support high availability of the BlackBerry Enterprise Server components. 2. Requirements: BlackBerry Administration API Item operating system Requirement Any of the following operating systems: • • • • • computer Internet browser Windows Server® 2003 SP1 or later Windows Server 2003 R2 Windows Server 2003 (64-bit) Windows Server 2003 R2 SP2 (64-bit) Windows® Small Business Server 2003 Standard or Premium minimum 2 GB of RAM available Microsoft® Internet Explorer® version 6. 2 .

Complete the instructions on the screen. you might wait several minutes before you can access the BlackBerry Administration Service.Application Service. After you finish: In the Microsoft® Services. 3 . restart the BlackBerry Administration Service .Installation Guide Install the BlackBerry Administration API 3. After you restart the service.

For more information on the permissions that developers require to use a specific API. on the BlackBerry solution management menu. the request is not completed. In the BlackBerry® Administration Service. Create a role You can create a role for an administrator account if existing roles do not match the criteria that your organization specified for a type of administrator account. In the Role information section. 7. 1. Click Edit role. 4 . 8. Switch the appropriate tabs to turn on the appropriate permissions. all permissions are turned off. After you finish: Assign the role to an administrator account or group. Click Save. An application that uses the BlackBerry Administration API requires an administrator account that has the appropriate permissions. when you create a role. your application must provide an administrator account name and password for the BlackBerry® Administration Service to authenticate your application and authorize your application to use the API. The permissions for tasks that an administrator or application can perform are defined by the roles that are assigned to the administrator account. can perform in the BlackBerry Administration Service. Permissions are associated with each task that an administrator. you can copy the existing role and make the appropriate changes to it. Make sure that your developers use administrator accounts that have the necessary permissions to perform the required tasks. You can provide the developers with the credentials of an existing administrator account or you can create a new account specifically for applications that use the BlackBerry® Administration API. Click Save all. expand Role. 6. see the API reference for the BlackBerry Administration API. Applications can use the same administrator account name and password that administrators use to log in to the BlackBerry Administration Service. If the administrator account that an application uses does not have the necessary permissions to complete an API request. 5. 1. 2. expand Role. In the BlackBerry® Administration Service. click the name of the role that you created. on the BlackBerry solution management menu. By default. Click Create a role.Installation Guide Creating administrator accounts for your application Creating administrator accounts for your application 2 When your application invokes an API. 4. Create a role based on an existing role To create a role for administrator accounts that is similar to an existing role. Type a name and description for the role. 3. or an application.

Click Edit role. provide the login information to the administrator and add the administrator account to a group or assign additional roles to the administrator account. 1. 9. 3. Click Save all. Click Copy role. Click Manage roles. After you finish: To configure the administrator account. In the Role information section. In the Role drop-down list. click the name of the role that you created. 4. click the role that you want to assign to the administrator account. 7.Installation Guide Create an administrator account 2. Before you begin: Verify that you can configure the authentication type and roles for an administrator account. Click Create an administrator user. After you finish: Assign the role to an administrator account or group. 4. 5 . 3. Click Copy role. 8. In the BlackBerry® Administration Service. Click Create an administrator user. 6. click the role that you want to copy. Create an administrator account You can create an administrator account when you want to assign administrative permissions to an administrator in your organization. Type the required information. Type a name and description for the role. expand Administrator user. 5. 10. Switch the appropriate tabs to change the appropriate permissions. on the BlackBerry solution management menu. In the list of existing roles. 5. 2.

6 .Installation Guide Glossary Glossary API application programming interface 3 DNS A Domain Name System (DNS) is an Internet database that translates domain names that are meaningful and recognizable by people into the numeric IP addresses that the Internet uses.

blackberry. 4 7 . visit www.com/docsfeedback.Installation Guide Provide feedback Provide feedback To provide feedback on this deliverable.

RIM makes no commitment to provide any such changes. Java® and JavaScript® are trademarks of Sun Microsystems. SERVICE. any Third Party Products and Services including.S. REPRESENTATIONS OR WARRANTIES OF DURABILITY. representation. YOU MAY ALSO HAVE OTHER RIGHTS THAT VARY BY STATE OR PROVINCE. performance. INCLUDING WITHOUT LIMITATION. D445. 6.428.318.S. compatibility. MERCHANTABLE QUALITY. SurePress™ and related trademarks. and countries around the world. technical.rim. MERCHANTABILITY. and is not responsible for.442. hardware or software. ANY CONDITIONS.075.470. FITNESS FOR A PARTICULAR PURPOSE OR USE. 6. OR TITLE.271. D416. The inclusion of a reference to Third Party Products and Services in this documentation does not imply endorsement by RIM of the Third Party Products and Services or the third party in any way. Other patents are registered or pending in the U. EXPRESS OR IMPLIED. endorsement. GUARANTEES. BUT CAN BE LIMITED. In order to protect RIM proprietary and confidential information and/or trade secrets.com/patents for a list of RIM (as hereinafter defined) patents. enhancements. without limitation the content. ARE HEREBY LIMITED TO NINETY (90) DAYS FROM THE DATE YOU FIRST ACQUIRED THE DOCUMENTATION OR THE ITEM THAT IS THE SUBJECT OF THE CLAIM. OR WARRANTIES OF ANY KIND.460. The BlackBerry smartphone and other devices and/or associated software are protected by copyright. accuracy. SATISFACTORY QUALITY. however. SureType®.blackberry. copyright compliance. OR RELATED TO THE DOCUMENTATION OR ITS USE.694. BlackBerry®. decency. TO THE EXTENT PERMITTED BY LAW. updates. OR ANY THIRD PARTY PRODUCTS AND SERVICES REFERENCED HEREIN. OR PERFORMANCE OR NON-PERFORMANCE OF ANY SOFTWARE. and various patents. Windows®. international treaties. trustworthiness. This documentation might contain references to third-party sources of information. products or services including components and content such as content protected by copyright and/or third-party web sites (collectively the "Third Party Products and Services"). links. names. RIM®. NONINFRINGEMENT. this documentation may describe some aspects of RIM technology in generalized terms. errors. or omissions in this documentation. Visit www. Microsoft®. patents: 6. 8 .S. 6. 6.073.com/go/docs is provided or made accessible "AS IS" and "AS AVAILABLE" and without condition. SOME JURISDICTIONS MAY NOT ALLOW THE EXCLUSION OR LIMITATION OF IMPLIED WARRANTIES AND CONDITIONS. ANY IMPLIED WARRANTIES OR CONDITIONS RELATING TO THE DOCUMENTATION TO THE EXTENT THEY CANNOT BE EXCLUDED AS SET OUT ABOVE. Inc. All other trademarks are the property of their respective owners. legality. This documentation including all documentation incorporated by reference herein such as documentation provided or made available at www.Installation Guide Legal notice Legal notice 5 ©2009 Research In Motion Limited. OR ARISING FROM A STATUTE OR CUSTOM OR A COURSE OF DEALING OR USAGE OF TRADE. EXCEPT TO THE EXTENT SPECIFICALLY PROHIBITED BY APPLICABLE LAW IN YOUR JURISDICTION. and logos are the property of Research In Motion Limited and are registered and/or used in the U. ENDORSEMENTS.219. REPRESENTATIONS. and Windows Server® are trademarks of Microsoft Corporation. guarantee. GUARANTEES.605. ENDORSEMENTS. HARDWARE. Internet Explorer. RIM reserves the right to periodically change information that is contained in this documentation. RIM does not control. All rights reserved. Research In Motion®. or warranty of any kind by Research In Motion Limited and its affiliated companies ("RIM") and RIM assumes no responsibility for any typographical. ARE HEREBY EXCLUDED. or other inaccuracies. D433.256. or any other aspect of Third Party Products and Services. or other additions to this documentation to you in a timely manner or at all. ALL CONDITIONS.278. including one or more of the following U. and in various countries around the world.

LOSS OF THE USE OF RIM PRODUCTS OR SERVICES OR ANY PORTION THEREOF OR OF ANY AIRTIME SERVICES. PUNITIVE. FAILURE TO REALIZE ANY EXPECTED SAVINGS. DISTRIBUTOR. Any Third Party Products and Services that are provided with RIM's products and services are provided as a convenience to you and are provided "AS IS" with no express or implied conditions. AND EVEN IF RIM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. LOSS OF BUSINESS INFORMATION. Check with your service provider for availability. HARDWARE. CONSEQUENTIAL. OR ANY THIRD PARTY PRODUCTS AND SERVICES REFERENCED HEREIN INCLUDING WITHOUT LIMITATION ANY OF THE FOLLOWING DAMAGES: DIRECT. SUPPLIERS (INCLUDING AIRTIME SERVICE PROVIDERS). FACILITIES OR SERVICES. roaming arrangements. INDIRECT. DEMAND. INCIDENTAL. OR PERFORMANCE OR NONPERFORMANCE OF ANY SOFTWARE. STRICT LIABILITY OR ANY OTHER LEGAL THEORY AND SHALL SURVIVE A FUNDAMENTAL BREACH OR BREACHES OR THE FAILURE OF THE ESSENTIAL PURPOSE OF THIS AGREEMENT OR OF ANY REMEDY CONTAINED HEREIN. trademark. ASSIGNS. THE LIMITATIONS. OR CORRUPTION OR LOSS OF DATA. it is your responsibility to ensure that your airtime service provider has agreed to support all of their features. EXEMPLARY. copyright. or using any Third Party Products and Services. endorsements. EMPLOYEES. If required you are responsible for acquiring them. BlackBerry® Desktop Software. OR ACTION BY YOU INCLUDING BUT NOT LIMITED TO BREACH OF CONTRACT. SPECIAL. IN NO EVENT SHALL ANY DIRECTOR. IN NO EVENT SHALL RIM BE LIABLE FOR ANY TYPE OF DAMAGES RELATED TO THIS DOCUMENTATION OR ITS USE. OR AGGRAVATED DAMAGES. NEGLIGENCE. and/or BlackBerry® Device Software. 9 . EMPLOYEE. BUSINESS INTERRUPTION. Some airtime service providers might not offer Internet browsing functionality with a subscription to the BlackBerry® Internet Service. Prior to subscribing for. TORT. LOSS OF BUSINESS OPPORTUNITY. service plans and features. Installation or use of Third Party Products and Services with RIM's products and services may require one or more patent. COST OF SUBSTITUTE GOODS. Your use of Third Party Products and Services shall be governed by and subject to you agreeing to the terms of separate licenses and other agreements applicable thereto with third parties. OR OTHERWISE TO YOU INCLUDING ANY LIABILITY FOR NEGLIGENCE OR STRICT LIABILITY. DAMAGES FOR LOSS OF PROFITS OR REVENUES. AGENTS. WHETHER OR NOT SUCH DAMAGES WERE FORESEEN OR UNFORESEEN. OR OTHER SIMILAR PECUNIARY LOSSES. TORT. EXCLUSIONS. INDEPENDENT CONTRACTOR OF RIM OR ANY AFFILIATES OF RIM HAVE ANY LIABILITY ARISING FROM OR RELATED TO THE DOCUMENTATION. in relation thereto. OR LIABILITY WHATSOEVER IN CONTRACT. THEIR SUCCESSORS. AUTHORIZED RIM DISTRIBUTORS (ALSO INCLUDING AIRTIME SERVICE PROVIDERS) AND THEIR RESPECTIVE DIRECTORS. You are solely responsible for determining whether to use Third Party Products and Services and if any third party licenses are required to do so. SERVICE. COST OF CAPITAL.Installation Guide Legal notice TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW IN YOUR JURISDICTION. AGENT. guarantees. You should not install or use Third Party Products and Services until all necessary licenses have been acquired. PROBLEMS ASSOCIATED WITH ANY APPLICATIONS USED IN CONJUNCTION WITH RIM PRODUCTS OR SERVICES. installing. DUTY. DOWNTIME COSTS. AND DISCLAIMERS HEREIN SHALL APPLY: (A) IRRESPECTIVE OF THE NATURE OF THE CAUSE OF ACTION. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW IN YOUR JURISDICTION. COSTS OF COVER. RIM SHALL HAVE NO OTHER OBLIGATION. or other licenses in order to avoid infringement or violation of third party rights. except to the extent expressly covered by a license or other agreement with RIM. representations. IN ADDITION TO THE LIMITATIONS AND EXCLUSIONS SET OUT ABOVE. Certain features outlined in this documentation require a minimum version of BlackBerry® Enterprise Server. FAILURES TO TRANSMIT OR RECEIVE ANY DATA. SUPPLIER. AND INDEPENDENT CONTRACTORS. AND (B) TO RIM AND ITS AFFILIATED COMPANIES. or warranties of any kind by RIM and RIM assumes no liability whatsoever.

Research In Motion Limited 295 Phillip Street Waterloo.Installation Guide Legal notice The terms of use of any RIM product or service are set out in a separate license or other agreement with RIM applicable thereto. Surrey TW20 9LF United Kingdom Published in Canada 10 . see the NOTICE. For more information. Keio University). Copyright © 1998-2003 World Wide Web Consortium (Massachusetts Institute of Technology. All Rights Reserved.apache.apache. ON N2L 3W8 Canada Research In Motion UK Limited Centrum House 36 Station Road Egham. This product includes software developed by the Apache Software Foundation (www. This product contains a modified version of HTML Tidy. European Research Consortium for Informatics and Mathematics. Certain features outlined in this documentation might require additional development or Third Party Products and Services for access to corporate applications.org/) and/or is licensed pursuant to one of the licenses listed at (www.org/licenses/). NOTHING IN THIS DOCUMENTATION IS INTENDED TO SUPERSEDE ANY EXPRESS WRITTEN AGREEMENTS OR WARRANTIES PROVIDED BY RIM FOR PORTIONS OF ANY RIM PRODUCT OR SERVICE OTHER THAN THIS DOCUMENTATION.txt file included with the software.