Start a forgot-password request for a local-login account

curl --request POST \
  --url http://10.2.4.166:8080/composer/api/password-reset/initiate \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --data '
{
  "userName": "jdoe"
}
'

import requests

url = "http://10.2.4.166:8080/composer/api/password-reset/initiate"

payload = { "userName": "jdoe" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/vnd.composer.v3+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/vnd.composer.v3+json'
  },
  body: JSON.stringify({userName: 'jdoe'})
};

fetch('http://10.2.4.166:8080/composer/api/password-reset/initiate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/password-reset/initiate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'userName' => 'jdoe'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/vnd.composer.v3+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://10.2.4.166:8080/composer/api/password-reset/initiate"

	payload := strings.NewReader("{\n  \"userName\": \"jdoe\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/vnd.composer.v3+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://10.2.4.166:8080/composer/api/password-reset/initiate")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("{\n  \"userName\": \"jdoe\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/password-reset/initiate")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n  \"userName\": \"jdoe\"\n}"

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

{
  "status": "REQUEST_ACCEPTED",
  "message": "<string>"
}

Start a forgot-password request for a local-login account

curl --request POST \
  --url http://10.2.4.166:8080/composer/api/password-reset/initiate \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --data '
{
  "userName": "jdoe"
}
'

import requests

url = "http://10.2.4.166:8080/composer/api/password-reset/initiate"

payload = { "userName": "jdoe" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/vnd.composer.v3+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/vnd.composer.v3+json'
  },
  body: JSON.stringify({userName: 'jdoe'})
};

fetch('http://10.2.4.166:8080/composer/api/password-reset/initiate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/password-reset/initiate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'userName' => 'jdoe'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/vnd.composer.v3+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://10.2.4.166:8080/composer/api/password-reset/initiate"

	payload := strings.NewReader("{\n  \"userName\": \"jdoe\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/vnd.composer.v3+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://10.2.4.166:8080/composer/api/password-reset/initiate")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("{\n  \"userName\": \"jdoe\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/password-reset/initiate")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n  \"userName\": \"jdoe\"\n}"

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

{
  "status": "REQUEST_ACCEPTED",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

HTTP Basic authentication using global administrator credentials (username and password).

Body

application/vnd.composer.v3+json

Request body for starting a forgot-password reset

userName

string

required

Username of the local-login account to reset

Minimum string length: 1

Example:

"jdoe"

Response

200 - application/vnd.composer.v3+json

Outcome of a forgot-password request/validate/confirm call

status

string

Machine-readable outcome

Example:

"REQUEST_ACCEPTED"

message

string

Human-readable message describing the outcome

Release Notes

Administer

Connect to Data

Present Data

Embed and Extend

Reference

Start a forgot-password request for a local-login account

Authorizations

Body

Response