Skip to content
Authrim

Create approval passkey options

POST
/api/approval-artifacts/{artifactId}/passkey/options
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/approval-artifacts/example/passkey/options \
  --header 'Content-Type: application/json' \
  --data '{ "rp_id": "admin.test.authrim.com" }'

Create WebAuthn authentication options for a passkey-bound approval artifact.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
artifactId
required
string

Request Body

Section titled “Request Body ”

Create passkey authentication options for approval completion.

Media type application/json
object
rp_id
string
Example 
{
  "rp_id": "admin.test.authrim.com"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Passkey authentication options for approval artifact completion.

Media type application/json
object
options
required
object
key
additional properties
challenge_id
required
string
completion_requirements
required
object
key
additional properties
Example 
{
  "options": {
    "challenge": "challenge",
    "rpId": "admin.test.authrim.com",
    "allowCredentials": [
      {
        "id": "credential_123",
        "type": "public-key",
        "transports": [
          "internal"
        ]
      }
    ],
    "userVerification": "required"
  },
  "challenge_id": "apc_123:pk:challenge_123",
  "completion_requirements": {
    "method": "passkey",
    "transport_channel": null,
    "acceptable_methods": [
      "passkey"
    ]
  }
}

default

Section titled “default ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}