Create or update passkey config

PUT

session

apps

{appID}

config

passkey

Create or update passkey config

curl --request PUT \
  --url https://api.prelude.dev/v2/session/apps/{appID}/config/passkey \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rp_id": "<string>",
  "rp_name": "<string>",
  "allowed_origins": [
    "<string>"
  ]
}
'

import requests

url = "https://api.prelude.dev/v2/session/apps/{appID}/config/passkey"

payload = {
    "rp_id": "<string>",
    "rp_name": "<string>",
    "allowed_origins": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({rp_id: '<string>', rp_name: '<string>', allowed_origins: ['<string>']})
};

fetch('https://api.prelude.dev/v2/session/apps/{appID}/config/passkey', 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.prelude.dev/v2/session/apps/{appID}/config/passkey",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'rp_id' => '<string>',
    'rp_name' => '<string>',
    'allowed_origins' => [
        '<string>'
    ]
  ]),
  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.prelude.dev/v2/session/apps/{appID}/config/passkey"

	payload := strings.NewReader("{\n  \"rp_id\": \"<string>\",\n  \"rp_name\": \"<string>\",\n  \"allowed_origins\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.prelude.dev/v2/session/apps/{appID}/config/passkey")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rp_id\": \"<string>\",\n  \"rp_name\": \"<string>\",\n  \"allowed_origins\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.prelude.dev/v2/session/apps/{appID}/config/passkey")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"rp_id\": \"<string>\",\n  \"rp_name\": \"<string>\",\n  \"allowed_origins\": [\n    \"<string>\"\n  ]\n}"

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

{
  "config": {
    "rp_id": "<string>",
    "rp_name": "<string>",
    "allowed_origins": [
      "<string>"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "code": "invalid_request",
  "status": "bad_request",
  "message": "<string>"
}

{
  "code": "app_not_found",
  "status": "not_found",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

appID

string

required

The id of the app the request refers to. An application's unique identifier.

Examples:

"54e9ujn"

"fvua38g"

Body

application/json

rp_id

string

required

The WebAuthn Relying Party identifier (typically your domain).

Example:

"example.com"

rp_name

string

required

A human-readable display name for the Relying Party.

Example:

"Example App"

allowed_origins

string[]

required

HTTPS origins allowed to perform WebAuthn operations.

Example:

["https://app.example.com"]

user_verification

enum<string>

WebAuthn user verification requirement. Defaults to required when omitted.

Available options:

required,

preferred,

discouraged

Example:

"required"

attestation_preference

enum<string>

WebAuthn attestation conveyance preference. Defaults to none when omitted.

Available options:

none,

indirect,

direct,

enterprise

Example:

"none"

Response

config

object

required

Show child attributes

Create or update passkey config

curl --request PUT \
  --url https://api.prelude.dev/v2/session/apps/{appID}/config/passkey \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rp_id": "<string>",
  "rp_name": "<string>",
  "allowed_origins": [
    "<string>"
  ]
}
'

import requests

url = "https://api.prelude.dev/v2/session/apps/{appID}/config/passkey"

payload = {
    "rp_id": "<string>",
    "rp_name": "<string>",
    "allowed_origins": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({rp_id: '<string>', rp_name: '<string>', allowed_origins: ['<string>']})
};

fetch('https://api.prelude.dev/v2/session/apps/{appID}/config/passkey', 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.prelude.dev/v2/session/apps/{appID}/config/passkey",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'rp_id' => '<string>',
    'rp_name' => '<string>',
    'allowed_origins' => [
        '<string>'
    ]
  ]),
  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.prelude.dev/v2/session/apps/{appID}/config/passkey"

	payload := strings.NewReader("{\n  \"rp_id\": \"<string>\",\n  \"rp_name\": \"<string>\",\n  \"allowed_origins\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.prelude.dev/v2/session/apps/{appID}/config/passkey")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rp_id\": \"<string>\",\n  \"rp_name\": \"<string>\",\n  \"allowed_origins\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.prelude.dev/v2/session/apps/{appID}/config/passkey")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"rp_id\": \"<string>\",\n  \"rp_name\": \"<string>\",\n  \"allowed_origins\": [\n    \"<string>\"\n  ]\n}"

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

{
  "config": {
    "rp_id": "<string>",
    "rp_name": "<string>",
    "allowed_origins": [
      "<string>"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "code": "invalid_request",
  "status": "bad_request",
  "message": "<string>"
}

{
  "code": "app_not_found",
  "status": "not_found",
  "message": "<string>"
}