Update a key vault
curl --request PATCH \
--url https://api.userplay.io/public/v1/studios/{studioId}/key-vaults/{keyVaultId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"vaultName": "<string>",
"vaultDescription": "<string>",
"onboardingIdentityProviders": []
}
'import requests
url = "https://api.userplay.io/public/v1/studios/{studioId}/key-vaults/{keyVaultId}"
payload = {
"vaultName": "<string>",
"vaultDescription": "<string>",
"onboardingIdentityProviders": []
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
vaultName: '<string>',
vaultDescription: '<string>',
onboardingIdentityProviders: []
})
};
fetch('https://api.userplay.io/public/v1/studios/{studioId}/key-vaults/{keyVaultId}', 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.userplay.io/public/v1/studios/{studioId}/key-vaults/{keyVaultId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'vaultName' => '<string>',
'vaultDescription' => '<string>',
'onboardingIdentityProviders' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.userplay.io/public/v1/studios/{studioId}/key-vaults/{keyVaultId}"
payload := strings.NewReader("{\n \"vaultName\": \"<string>\",\n \"vaultDescription\": \"<string>\",\n \"onboardingIdentityProviders\": []\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.userplay.io/public/v1/studios/{studioId}/key-vaults/{keyVaultId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"vaultName\": \"<string>\",\n \"vaultDescription\": \"<string>\",\n \"onboardingIdentityProviders\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.userplay.io/public/v1/studios/{studioId}/key-vaults/{keyVaultId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"vaultName\": \"<string>\",\n \"vaultDescription\": \"<string>\",\n \"onboardingIdentityProviders\": []\n}"
response = http.request(request)
puts response.read_body{
"data": {
"keyVaultId": "<string>",
"studioId": "<string>",
"playtestId": "<string>",
"vaultName": "<string>",
"vaultDescription": "<string>",
"keyType": "steam",
"steamKeyType": "playtest_standard",
"steamRedeemScope": "game",
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"stage": "draft",
"keyDistributionScreening": [
{
"id": "<string>",
"type": "heading",
"text": "<string>"
}
],
"keyEligibility": {
"match": "all",
"conditions": [
{
"questionId": "<string>",
"operator": "isAnyOf",
"value": "<string>"
}
]
},
"postScreeningView": [
{
"id": "<string>",
"type": "heading",
"text": "<string>"
}
]
}
}Key vaults
Update a key vault
PATCH
/
studios
/
{studioId}
/
key-vaults
/
{keyVaultId}
Update a key vault
curl --request PATCH \
--url https://api.userplay.io/public/v1/studios/{studioId}/key-vaults/{keyVaultId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"vaultName": "<string>",
"vaultDescription": "<string>",
"onboardingIdentityProviders": []
}
'import requests
url = "https://api.userplay.io/public/v1/studios/{studioId}/key-vaults/{keyVaultId}"
payload = {
"vaultName": "<string>",
"vaultDescription": "<string>",
"onboardingIdentityProviders": []
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
vaultName: '<string>',
vaultDescription: '<string>',
onboardingIdentityProviders: []
})
};
fetch('https://api.userplay.io/public/v1/studios/{studioId}/key-vaults/{keyVaultId}', 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.userplay.io/public/v1/studios/{studioId}/key-vaults/{keyVaultId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'vaultName' => '<string>',
'vaultDescription' => '<string>',
'onboardingIdentityProviders' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.userplay.io/public/v1/studios/{studioId}/key-vaults/{keyVaultId}"
payload := strings.NewReader("{\n \"vaultName\": \"<string>\",\n \"vaultDescription\": \"<string>\",\n \"onboardingIdentityProviders\": []\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.userplay.io/public/v1/studios/{studioId}/key-vaults/{keyVaultId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"vaultName\": \"<string>\",\n \"vaultDescription\": \"<string>\",\n \"onboardingIdentityProviders\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.userplay.io/public/v1/studios/{studioId}/key-vaults/{keyVaultId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"vaultName\": \"<string>\",\n \"vaultDescription\": \"<string>\",\n \"onboardingIdentityProviders\": []\n}"
response = http.request(request)
puts response.read_body{
"data": {
"keyVaultId": "<string>",
"studioId": "<string>",
"playtestId": "<string>",
"vaultName": "<string>",
"vaultDescription": "<string>",
"keyType": "steam",
"steamKeyType": "playtest_standard",
"steamRedeemScope": "game",
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"stage": "draft",
"keyDistributionScreening": [
{
"id": "<string>",
"type": "heading",
"text": "<string>"
}
],
"keyEligibility": {
"match": "all",
"conditions": [
{
"questionId": "<string>",
"operator": "isAnyOf",
"value": "<string>"
}
]
},
"postScreeningView": [
{
"id": "<string>",
"type": "heading",
"text": "<string>"
}
]
}
}Authorizations
Personal API key (prefix up_). Create one in the studio under Account → API keys.
Body
application/json
New display name for the vault.
Required string length:
2 - 80New description for the vault. Pass null to clear it.
Maximum string length:
2000Switch the credential type this vault holds.
Available options:
steam, custom Steam key variant (playtest_standard, default_release, release_state_override, developer_autogrant). Only when keyType is 'steam'.
Available options:
playtest_standard, default_release, release_state_override, developer_autogrant, null What a Steam key unlocks (game, dlc, bundle). Only when keyType is 'steam'.
Available options:
game, dlc, bundle, null The identities a recipient must hold before claiming a key, in canonical order. Pass null to reset to the default (email).
Minimum array length:
1Available options:
email, discord, steam, google Response
200 - application/json
The updated key vault
Show child attributes
Show child attributes
⌘I