To access the Address Manager API, the script or application must log in to Address Manager using an API user account.
All API implementations must first connect to the Address Manager API service, and then log in to start a session. None of the Address Manager API functionality described in the following subsections is accessible unless an API user logs on to the system. Address Manager API users have a specific access type (API) and cannot log in to Address Manager through the GUI (Graphical User Interface). Similarly, non-API users cannot connect to Address Manager through the API interface.
To connect to the service, you need the IP address for the Address Manager server. Logging in creates a session for that user with a timeout limit corresponding to that set for all users. API users must also log out after the required operations have been completed.
For more information about API access, refer to the Address Manager Administration Guide or the online Help.
- Using the Address Manager web interface, log in to Address Manager as an administrator.
- On the Administration page, click Users and Groups. The Users and Groups page appears.
- In the Users section, click New . The Add User page appears.
- In the User section, type a name in the Username field.
- In the Authentication section, type and confirm the API user password in the Password and Confirm Password fields. If external authenticators are available, an Other checkbox and a list of authenticators appears in the Authentication section. To use an external authenticator for the API user, click the Other checkbox, and then select an authenticator from the list.
In the Extra Information section, set the following parameters:
- E-mail Address
- Type an email address for the API user. This information is required.
- Phone number
- Type a phone number for the API user. This information is optional.
In the User Access section you define the user type,
security and history privileges, and access type:
- Type of User
- Select the type of user, either Non-Administrator or Administrator. Non-Administrator users have access only to DNS and IPAM management functions. Administrator users have unlimited access to all Address Manager functions.
- Security Privilege
- select a security privilege type from the drop-down list. This field is available only for Non-Administrator users with GUI, API, or GUI and API access.
- History Privilege
- select a history privilege type from the drop-down list. This field is available only for Non-Administrator users with GUI, or GUI and API access.
- Access Type
- select the type of access; GUI, API, or GUI and API . GUI (Graphical User Interface) users can access Address Manager only through the Address Manager web interface. API (Application Programming Interface) users can access Address Manager only through the API. GUI and API users can access Address Manager either through the Address Manager web interface or the API.
- In the Assign to Group section, you can assign the user to one or more existing user groups. In the text field, type the name of a user group. As you type, a list of user groups matching your text appears. Select a name from the list, and then click Add to the right of the text field.
- In the Change Control section, add comments to describe the changes. This step is optional but may be set to be required.
- Click Add at the bottom of the page.