Create a WebAuthN registration link​
Create a link, which includes a code, that can either be returned or directly sent to the user. The code will allow the user to start a new WebAuthN registration.
Path Parameters
userId string required
unique identifier of the user.
application/json
application/grpc
application/grpc-web+proto
Request Body required
sendLink object
returnCode object
Get the code back to provide it to the user in your preferred mechanism.
Request Body required
sendLink object
returnCode object
Get the code back to provide it to the user in your preferred mechanism.
Request Body required
sendLink object
returnCode object
Get the code back to provide it to the user in your preferred mechanism.
Responses
- 200
- 403
- 404
- default
WebAuthN registration successfully created
application/json
application/grpc
application/grpc-web+proto
Schema
Example (from schema)
Schema
details object
code object
{
"details": {
"sequence": "2",
"changeDate": "2024-03-27T10:05:49.794Z",
"resourceOwner": "69629023906488334"
},
"code": {
"id": "e2a48d6a-362b-4db6-a1fb-34feab84dc62",
"code": "SKJd342k"
}
}
Schema
Example (from schema)
Schema
details object
code object
{
"details": {
"sequence": "2",
"changeDate": "2024-03-27T10:05:49.795Z",
"resourceOwner": "69629023906488334"
},
"code": {
"id": "e2a48d6a-362b-4db6-a1fb-34feab84dc62",
"code": "SKJd342k"
}
}
Schema
Example (from schema)
Schema
details object
code object
{
"details": {
"sequence": "2",
"changeDate": "2024-03-27T10:05:49.795Z",
"resourceOwner": "69629023906488334"
},
"code": {
"id": "e2a48d6a-362b-4db6-a1fb-34feab84dc62",
"code": "SKJd342k"
}
}
Returned when the user does not have permission to access the resource.
application/json
application/grpc
application/grpc-web+proto
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
application/json
application/grpc
application/grpc-web+proto
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
application/json
application/grpc
application/grpc-web+proto
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
POST /v3alpha/users/:userId/webauthn/registration_link
Authorization
name: OAuth2type: oauth2scopes:openid,urn:zitadel:iam:org:project:id:zitadel:aud
flows: { "authorizationCode": { "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize", "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token", "scopes": { "openid": "openid", "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud" } } }
Request
Request
curl / cURL
curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/webauthn/registration_link' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"sendLink": {
"urlTemplate": "https://example.com/passkey/register?userID={{.UserID}}&orgID={{.OrgID}}&codeID={{.CodeID}}&code={{.Code}}"
},
"returnCode": {}
}'
python / requests
curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/webauthn/registration_link' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"sendLink": {
"urlTemplate": "https://example.com/passkey/register?userID={{.UserID}}&orgID={{.OrgID}}&codeID={{.CodeID}}&code={{.Code}}"
},
"returnCode": {}
}'
go / native
curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/webauthn/registration_link' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"sendLink": {
"urlTemplate": "https://example.com/passkey/register?userID={{.UserID}}&orgID={{.OrgID}}&codeID={{.CodeID}}&code={{.Code}}"
},
"returnCode": {}
}'
nodejs / axios
curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/webauthn/registration_link' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"sendLink": {
"urlTemplate": "https://example.com/passkey/register?userID={{.UserID}}&orgID={{.OrgID}}&codeID={{.CodeID}}&code={{.Code}}"
},
"returnCode": {}
}'
ruby / Net::HTTP
curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/webauthn/registration_link' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"sendLink": {
"urlTemplate": "https://example.com/passkey/register?userID={{.UserID}}&orgID={{.OrgID}}&codeID={{.CodeID}}&code={{.Code}}"
},
"returnCode": {}
}'
csharp / RestSharp
curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/webauthn/registration_link' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"sendLink": {
"urlTemplate": "https://example.com/passkey/register?userID={{.UserID}}&orgID={{.OrgID}}&codeID={{.CodeID}}&code={{.Code}}"
},
"returnCode": {}
}'
php / cURL
curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/webauthn/registration_link' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"sendLink": {
"urlTemplate": "https://example.com/passkey/register?userID={{.UserID}}&orgID={{.OrgID}}&codeID={{.CodeID}}&code={{.Code}}"
},
"returnCode": {}
}'
java / OkHttp
curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/webauthn/registration_link' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"sendLink": {
"urlTemplate": "https://example.com/passkey/register?userID={{.UserID}}&orgID={{.OrgID}}&codeID={{.CodeID}}&code={{.Code}}"
},
"returnCode": {}
}'
powershell / RestMethod
curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/webauthn/registration_link' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"sendLink": {
"urlTemplate": "https://example.com/passkey/register?userID={{.UserID}}&orgID={{.OrgID}}&codeID={{.CodeID}}&code={{.Code}}"
},
"returnCode": {}
}'