curl --request POST \
--url https://api.example.com/portal/api/keys \
--header 'Content-Type: application/json' \
--cookie gproxy_session= \
--data '
{
"name": "<string>",
"expiresAtMs": null,
"organizationId": null,
"retainSecret": null,
"teamId": null
}
'import requests
url = "https://api.example.com/portal/api/keys"
payload = {
"name": "<string>",
"expiresAtMs": None,
"organizationId": None,
"retainSecret": None,
"teamId": None
}
headers = {
"cookie": "gproxy_session=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'gproxy_session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
expiresAtMs: null,
organizationId: null,
retainSecret: null,
teamId: null
})
};
fetch('https://api.example.com/portal/api/keys', 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.example.com/portal/api/keys",
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([
'name' => '<string>',
'expiresAtMs' => null,
'organizationId' => null,
'retainSecret' => null,
'teamId' => null
]),
CURLOPT_COOKIE => "gproxy_session=",
CURLOPT_HTTPHEADER => [
"Content-Type: application/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 := "https://api.example.com/portal/api/keys"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"expiresAtMs\": null,\n \"organizationId\": null,\n \"retainSecret\": null,\n \"teamId\": null\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "gproxy_session=")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/portal/api/keys")
.header("cookie", "gproxy_session=")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"expiresAtMs\": null,\n \"organizationId\": null,\n \"retainSecret\": null,\n \"teamId\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/portal/api/keys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cookie"] = 'gproxy_session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"expiresAtMs\": null,\n \"organizationId\": null,\n \"retainSecret\": null,\n \"teamId\": null\n}"
response = http.request(request)
puts response.read_body{
"enabled": true,
"expiresAtMs": 123,
"hasSecret": true,
"id": "<string>",
"name": "<string>",
"organizationId": "<string>",
"prefix": "<string>",
"teamId": "<string>",
"token": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}POST /portal/api/keys
curl --request POST \
--url https://api.example.com/portal/api/keys \
--header 'Content-Type: application/json' \
--cookie gproxy_session= \
--data '
{
"name": "<string>",
"expiresAtMs": null,
"organizationId": null,
"retainSecret": null,
"teamId": null
}
'import requests
url = "https://api.example.com/portal/api/keys"
payload = {
"name": "<string>",
"expiresAtMs": None,
"organizationId": None,
"retainSecret": None,
"teamId": None
}
headers = {
"cookie": "gproxy_session=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'gproxy_session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
expiresAtMs: null,
organizationId: null,
retainSecret: null,
teamId: null
})
};
fetch('https://api.example.com/portal/api/keys', 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.example.com/portal/api/keys",
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([
'name' => '<string>',
'expiresAtMs' => null,
'organizationId' => null,
'retainSecret' => null,
'teamId' => null
]),
CURLOPT_COOKIE => "gproxy_session=",
CURLOPT_HTTPHEADER => [
"Content-Type: application/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 := "https://api.example.com/portal/api/keys"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"expiresAtMs\": null,\n \"organizationId\": null,\n \"retainSecret\": null,\n \"teamId\": null\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "gproxy_session=")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/portal/api/keys")
.header("cookie", "gproxy_session=")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"expiresAtMs\": null,\n \"organizationId\": null,\n \"retainSecret\": null,\n \"teamId\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/portal/api/keys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cookie"] = 'gproxy_session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"expiresAtMs\": null,\n \"organizationId\": null,\n \"retainSecret\": null,\n \"teamId\": null\n}"
response = http.request(request)
puts response.read_body{
"enabled": true,
"expiresAtMs": 123,
"hasSecret": true,
"id": "<string>",
"name": "<string>",
"organizationId": "<string>",
"prefix": "<string>",
"teamId": "<string>",
"token": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}授权
请求体
What a portal user may choose when minting a key.
There is no userId: the key is the caller's. The two binding fields are
present because a user who belongs to a team wants a key scoped to it, and
they are validated by the same rules the admin family applies — the
organization and the team must exist, and the caller must be a member of
them.
Absent mints a key that never expires.
Keep a sealed copy so the key can be revealed later. False by default: a key the instance cannot reproduce is a key a database leak does not hand over.
响应
Success
A minted or rotated key. token is the only time the plaintext travels,
apart from an explicit reveal of a key that retained one.
Whether the instance retained a sealed copy, i.e. whether reveal can
answer for this key.
The first characters of the key body, for telling two keys apart.