GET /v1/loginWithOptions - BlueCat Address Manager - 9.3.0

Address Manager API Guide

Locale
English (United States)
Product name
BlueCat Address Manager
Version
9.3.0

Description

Logs in as an API user with the following options:
  • Change the locale to Japanese or Simplified Chinese.
    Note: Changing locale only affects the behavior of the getUserDefinedFields and updateBulkUdf methods.
  • Log in with a read-only API session.
    Note:
    • When logging in to Address Manager using a read-only API session, you must log in to the Secondary or Tertiary Address Manager server.
    • If you are logged in using a read-only API session, you can only use API methods that retrieve information. For more information on read-only API sessions and a list of API methods that support read-only API session, refer to Read-only API sessions.

Parameters

Name Description
options

Location: query

Type: string

You can use one of the following options to change the locale:
  • locale=ja-JA
  • locale=zh-CN
You can use the following option to initiate a read-only API session:
  • isReadOnly=true
password

Location: query

Type: string

The password for the API user logging into Address Manager.
username

Location: query

Type: string

The username for the API user created using the Address Manager user interface.

Responses

Code Description
200

Type: string

Returns the API authorization token.