AAPM Basic

1 min

GET

{{url}}/sc-aapm-ui/rest/aapm/password?passwordExpirationInMinute=30&passwordChangeRequired=TRUE&comment=COMMENT&token=ee3a55e7-5ea6-4c5b-9c20-474dcf8ae475&sapmAccountPath=/AAA&[email protected]&responseType=JSON&showUsername=false

Description:

This API allows you to change the password for all SAPM Accounts, including both Dynamic and Static types.

This method gives the secret data of bound SAPM account.

For AAPM accounts which are bound to a single SAPM account, the parameters sapmAccountPath and sapmAccountName are not needed.

For AAPM accounts which are bount to multiple SAPM accounts&groups the user must have set sapmAccountPath and sapmAccountName parameters together with the token.
responseType=JSON parameter returns the response as JSON.

Response Format Customization: By default, the response for dynamic accounts is in plain text. However, you can opt for a JSON response by setting the responseType parameter to JSON.
- If this parameter is not set, the return type for dynamic accounts are plain text.
Username Inclusion: The API offers the flexibility to either display or hide the username in the response. This is controlled by the showUsername parameter.

Path Parameters

urlstring
Default
url

Query Parameters

passwordExpirationInMinutestring
Default
30
passwordChangeRequiredstring
Default
TRUE
commentstring
Default
COMMENT
tokenstring
Default
ee3a55e7-5ea6-4c5b-9c20-474dcf8ae475
sapmAccountPathstring
Default
/AAA
sapmAccountNamestring
Default
[email protected]
responseTypestring
Default
JSON
showUsernamestring
Default
false
pinstring
Default
PIN

Header Parameters

Content-Typestring
Default
application/json
X-XSRF-TOKENstring
Default
{{csrftoken}}

Responses

200AAPM Basic

curl

curl --request GET \
     --url '{{url}}/sc-aapm-ui/rest/aapm/password?passwordExpirationInMinute=30&passwordChangeRequired=TRUE&comment=COMMENT&token=ee3a55e7-5ea6-4c5b-9c20-474dcf8ae475&sapmAccountPath=%2FAAA&sapmAccountName=test5%4010.20.42.106&responseType=JSON&showUsername=false&passwordExpirationInMinute=30&passwordChangeRequired=TRUE&comment=COMMENT&token=ee3a55e7-5ea6-4c5b-9c20-474dcf8ae475&sapmAccountPath=%2FAAA&sapmAccountName=test5%4010.20.42.106&responseType=JSON&showUsername=false&pin=PIN' \
     --header 'accept: application/json' \
     --header 'x-xsrf-token: {{csrftoken}}'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-xsrf-token", "{{csrftoken}}");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("{{url}}/sc-aapm-ui/rest/aapm/password?passwordExpirationInMinute=30&passwordChangeRequired=TRUE&comment=COMMENT&token=ee3a55e7-5ea6-4c5b-9c20-474dcf8ae475&sapmAccountPath=/AAA&[email protected]&responseType=JSON&showUsername=false&passwordExpirationInMinute=30&passwordChangeRequired=TRUE&comment=COMMENT&token=ee3a55e7-5ea6-4c5b-9c20-474dcf8ae475&sapmAccountPath=/AAA&[email protected]&responseType=JSON&showUsername=false&pin=PIN", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("{{url}}/sc-aapm-ui/rest/aapm/password?passwordExpirationInMinute=30&passwordChangeRequired=TRUE&comment=COMMENT&token=ee3a55e7-5ea6-4c5b-9c20-474dcf8ae475&sapmAccountPath=/AAA&[email protected]&responseType=JSON&showUsername=false&passwordExpirationInMinute=30&passwordChangeRequired=TRUE&comment=COMMENT&token=ee3a55e7-5ea6-4c5b-9c20-474dcf8ae475&sapmAccountPath=/AAA&[email protected]&responseType=JSON&showUsername=false&pin=PIN")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-xsrf-token"] = "{{csrftoken}}"

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "{{url}}/sc-aapm-ui/rest/aapm/password?passwordExpirationInMinute=30&passwordChangeRequired=TRUE&comment=COMMENT&token=ee3a55e7-5ea6-4c5b-9c20-474dcf8ae475&sapmAccountPath=/AAA&[email protected]&responseType=JSON&showUsername=false&passwordExpirationInMinute=30&passwordChangeRequired=TRUE&comment=COMMENT&token=ee3a55e7-5ea6-4c5b-9c20-474dcf8ae475&sapmAccountPath=/AAA&[email protected]&responseType=JSON&showUsername=false&pin=PIN"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'x-xsrf-token': '{{csrftoken}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

{
    "secret": {
        "password": "zHZ4M8qw"
    },
    "properties": {
        "dbId": 349813,
        "device": {
            "dbId": 349680,
            "name": "10.20.42.106",
            "accessProtocol": "SSHv2",
            "managementIp": "10.20.42.106"
        },
        "secretName": "[email protected]",
        "changePeriod": 10080,
        "description": null,
        "secretNotes": null,
        "lastChangeTime": 1697450626335,
        "nextChangeTime": 1697452431760,
        "passwordSeenStatus": "SEEN",
        "validationStatus": "VALID",
        "parentSapmGroup": {
            "dbId": 1223807,
            "name": "AAA"
        },
        "secretType": "DYNAMIC",
        "owner": {
            "id": "25e53f47-ce66-4df2-9abc-6961dc668264",
            "eid": "admin"
        },
        "createdAt": 1684930878335,
        "updatedAt": 1697450631113,
        "approvalStatus": null,
        "groupFullPath": "/AAA",
        "approvedBy": null,
        "approvedDate": null,
        "approvalRequired": false
    }
}