Register a new passkey

POST/v2/users/self/passkeys

API-Version

v2

Request-Methode

POST

Operation-ID

user-create-passkey

---

Create the challenge with POST /users/self/passkey-registration-challenges first.

Request

Responses

Format

application/json

Beschreibung

The passkey has been registered.

• idstring (uuid)required
• recoveryCodesArray von string (≥ 16 Zeichen, ≤ 16 Zeichen)

  Only set if the passkey is the first second factor of the user.

  • Array[
    • *string (≥ 16 Zeichen, ≤ 16 Zeichen)
    ]

Content-Type: application/json

{
  "id": "f0f86186-0a5a-45b2-aa33-502777496347",
  "recoveryCodes": [
    "1234123412341234"
  ]
}

{
  "properties": {
    "id": {
      "format": "uuid",
      "type": "string"
    },
    "recoveryCodes": {
      "description": "Only set if the passkey is the first second factor of the user.",
      "items": {
        "example": "1234123412341234",
        "maxLength": 16,
        "minLength": 16,
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "id"
  ],
  "type": "object"
}

Nutzungsbeispiele

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"challengeId":"f0f86186-0a5a-45b2-aa33-502777496347","credential":{"authenticatorAttachment":"platform","clientExtensionResults":{"credProps":{"rk":true}},"id":"AN29uP9UVfVZ1X0WLKg3zA","rawId":"AN29uP9UVfVZ1X0WLKg3zA","response":{"attestationObject":"o2NmbXRkbm9uZWdhdHRTdG10oGhhdXRoRGF0YViU8q2Xwa9qKcqUca3Qox8O-H9rqwjlNp1O5WHPOETZnihdAAAAAAAAAAAAAAAAAAAAAAAAAAAAEADdvbj_VFX1WdV9FiyoN8ylAQIDJiABIVgg4BncA1wj5f8GHCfmeV4wP2AntUe6Pgoy_AoVQLA7DfsiWCBBLqMbbNzYlOxlYv0MYXEuXFBtx-nKRqJyytp3Rc7Frg","authenticatorData":"8q2Xwa9qKcqUca3Qox8O-H9rqwjlNp1O5WHPOETZnihdAAAAAAAAAAAAAAAAAAAAAAAAAAAAEADdvbj_VFX1WdV9FiyoN8ylAQIDJiABIVgg4BncA1wj5f8GHCfmeV4wP2AntUe6Pgoy_AoVQLA7DfsiWCBBLqMbbNzYlOxlYv0MYXEuXFBtx-nKRqJyytp3Rc7Frg","clientDataJSON":"eyJ0eXBlIjoid2ViYXV0aG4uY3JlYXRlIiwiY2hhbGxlbmdlIjoicmNVYTE2MzRZVWFDc0JlYXNyb1RWdWRCYjRqTlNuS3pUR3pKOUVkTGxyQSIsIm9yaWdpbiI6Imh0dHBzOi8vc3R1ZGlvLm1pdHR3YWxkLmRlIiwiY3Jvc3NPcmlnaW4iOmZhbHNlfQ","publicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE4BncA1wj5f8GHCfmeV4wP2AntUe6Pgoy_AoVQLA7DftBLqMbbNzYlOxlYv0MYXEuXFBtx-nKRqJyytp3Rc7Frg","publicKeyAlgorithm":-7,"transports":["hybrid","internal"]},"type":"public-key"},"name":"string"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/users/self/passkeys

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.user.createPasskey({
  "data": {
    "challengeId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "credential": {
      "authenticatorAttachment": "platform",
      "clientExtensionResults": {
        "credProps": {
          "rk": true
        }
      },
      "id": "AN29uP9UVfVZ1X0WLKg3zA",
      "rawId": "AN29uP9UVfVZ1X0WLKg3zA",
      "response": {
        "attestationObject": "o2NmbXRkbm9uZWdhdHRTdG10oGhhdXRoRGF0YViU8q2Xwa9qKcqUca3Qox8O-H9rqwjlNp1O5WHPOETZnihdAAAAAAAAAAAAAAAAAAAAAAAAAAAAEADdvbj_VFX1WdV9FiyoN8ylAQIDJiABIVgg4BncA1wj5f8GHCfmeV4wP2AntUe6Pgoy_AoVQLA7DfsiWCBBLqMbbNzYlOxlYv0MYXEuXFBtx-nKRqJyytp3Rc7Frg",
        "authenticatorData": "8q2Xwa9qKcqUca3Qox8O-H9rqwjlNp1O5WHPOETZnihdAAAAAAAAAAAAAAAAAAAAAAAAAAAAEADdvbj_VFX1WdV9FiyoN8ylAQIDJiABIVgg4BncA1wj5f8GHCfmeV4wP2AntUe6Pgoy_AoVQLA7DfsiWCBBLqMbbNzYlOxlYv0MYXEuXFBtx-nKRqJyytp3Rc7Frg",
        "clientDataJSON": "eyJ0eXBlIjoid2ViYXV0aG4uY3JlYXRlIiwiY2hhbGxlbmdlIjoicmNVYTE2MzRZVWFDc0JlYXNyb1RWdWRCYjRqTlNuS3pUR3pKOUVkTGxyQSIsIm9yaWdpbiI6Imh0dHBzOi8vc3R1ZGlvLm1pdHR3YWxkLmRlIiwiY3Jvc3NPcmlnaW4iOmZhbHNlfQ",
        "publicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE4BncA1wj5f8GHCfmeV4wP2AntUe6Pgoy_AoVQLA7DftBLqMbbNzYlOxlYv0MYXEuXFBtx-nKRqJyytp3Rc7Frg",
        "publicKeyAlgorithm": -7,
        "transports": [
          "hybrid",
          "internal"
        ]
      },
      "type": "public-key"
    },
    "name": "string"
  }
});

assertStatus(response, 201);
  

use \Mittwald\ApiClient\Generated\V2\Clients\User\CreatePasskey\CreatePasskeyRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\User\CreatePasskey\CreatePasskeyRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// CreatePasskeyRequestBody to learn how to construct a valid instance
$body = new CreatePasskeyRequestBody(/* TODO: ... */);

$request = (new CreatePasskeyRequest(
  body: $body
));
$response = $client->user()->createPasskey($request);

var_dump($response->getBody();