POST /bsus/api/v1/service_account/test - Adaptive Applications - BlueCat Gateway

POST /bsus/api/v1/service_account/test - Adaptive Applications - BlueCat Gateway - 23.1

BlueCat Server Update Services Administration Guide

Locale

English

Product name

BlueCat Gateway

Version

23.1

Tests a service account's connection to Address Manager.

Name Description

Name	Description
payload (body)	Location: body Type: application/json `{ "username": "string", "password": "string", "bam_url": "string" }` Where each parameter is as follows. `username`—the user name for the account that the API uses when signing in to Address Manager. `password`—the password for the account. `bam_url`—the URL for the instance of BlueCat Address Manager that the API signs in to.

payload

(body)

Location: body

Type: application/json

{
  "username": "string",
  "password": "string",
  "bam_url": "string"
}

Where each parameter is as follows.

username—the user name for the account that the API uses when signing in to Address Manager.
password—the password for the account.
bam_url—the URL for the instance of BlueCat Address Manager that the API signs in to.

Status Description

Status	Description
Successful	Code: 200 Body: `{ message: "Test successfully" }`
Error	Code: 400 Body: `{ "error": "<details>" }` Code: 404 Body: `{ "error": "User '{name}' not found" }` If available, additional details are passed in the return parameter `error`.

Successful

Code: 200

Body:

{
  message: "Test successfully"
}

Error

Code: 400

Body:

{
  "error": "<details>"
}

Code: 404

Body:

{
  "error": "User '{name}' not found"
}

If available, additional details are passed in the return parameter error.