curl --request GET \
--url https://api.useanima.sh/v1/provisioning-requests/{requestId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.useanima.sh/v1/provisioning-requests/{requestId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.useanima.sh/v1/provisioning-requests/{requestId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useanima.sh/v1/provisioning-requests/{requestId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.useanima.sh/v1/provisioning-requests/{requestId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.useanima.sh/v1/provisioning-requests/{requestId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useanima.sh/v1/provisioning-requests/{requestId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"requestId": "<string>",
"agentId": "<string>",
"agentName": "<string>",
"resource": "VAULT",
"reason": "<string>",
"status": "PENDING",
"options": {
"countryCode": "<string>",
"areaCode": "<string>"
},
"permission": {
"procedurePath": "<string>",
"readOnly": true,
"argumentPreview": {}
},
"expiresAt": "2023-11-07T05:31:56Z",
"decidedAt": "2023-11-07T05:31:56Z",
"decidedNote": "<string>",
"provisionedId": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}{
"defined": true,
"code": "NOT_FOUND",
"status": 404,
"message": "No such provisioning request in this organization.",
"data": "<unknown>"
}Get provisioning requests 1
curl --request GET \
--url https://api.useanima.sh/v1/provisioning-requests/{requestId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.useanima.sh/v1/provisioning-requests/{requestId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.useanima.sh/v1/provisioning-requests/{requestId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useanima.sh/v1/provisioning-requests/{requestId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.useanima.sh/v1/provisioning-requests/{requestId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.useanima.sh/v1/provisioning-requests/{requestId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useanima.sh/v1/provisioning-requests/{requestId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"requestId": "<string>",
"agentId": "<string>",
"agentName": "<string>",
"resource": "VAULT",
"reason": "<string>",
"status": "PENDING",
"options": {
"countryCode": "<string>",
"areaCode": "<string>"
},
"permission": {
"procedurePath": "<string>",
"readOnly": true,
"argumentPreview": {}
},
"expiresAt": "2023-11-07T05:31:56Z",
"decidedAt": "2023-11-07T05:31:56Z",
"decidedNote": "<string>",
"provisionedId": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}{
"defined": true,
"code": "NOT_FOUND",
"status": 404,
"message": "No such provisioning request in this organization.",
"data": "<unknown>"
}Authorizations
JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer
Path Parameters
Provisioning request identifier
1Response
OK
A provisioning request and its current state
Unique provisioning request identifier
Agent the resource would belong to
Agent display name, so the owner knows who is asking
Resource being requested: VAULT (encrypted secret storage for this agent), PHONE_NUMBER (a provisioned number, Starter+ only), or GENERIC (a master-gated operation the agent tried to perform; approving grants permission rather than provisioning anything).
VAULT, PHONE_NUMBER, GENERIC The agent's stated justification
Lifecycle status: PENDING (awaiting the owner), APPROVED (resource provisioned), DECLINED (owner refused — soft, the agent may ask again), EXPIRED (7-day TTL elapsed unanswered), CANCELLED (withdrawn by the agent).
PENDING, APPROVED, DECLINED, EXPIRED, CANCELLED Resource-specific options, if any
Show child attributes
Show child attributes
What the agent was refused, when this request records a permission rather than a resource
Show child attributes
Show child attributes
When an unanswered request stops being actionable
When the owner decided; null while PENDING
The owner's note, typically the reason for a decline — surfaced so a second attempt can address the objection instead of repeating the first
Id of what approval created (vault identity or phone identity); null unless APPROVED
When the agent asked
