Create a passkey registration link for a user
POST/v2/users/:userId/passkeys/registration_link
Create a passkey registration link which includes a code and either return it or send it to the user..
Request​
Path Parameters
- application/json
- application/grpc
- application/grpc-web+proto
Body
required
sendLink
object
Possible values: non-empty
and <= 200 characters
Optionally set a url_template, which will be used in the mail sent by ZITADEL to guide the user to your passkey registration page. If no template is set, the default ZITADEL url will be used.
The following placeholders can be used: UserID, OrgID, CodeID, Code
Body
required
sendLink
object
Possible values: non-empty
and <= 200 characters
Optionally set a url_template, which will be used in the mail sent by ZITADEL to guide the user to your passkey registration page. If no template is set, the default ZITADEL url will be used.
The following placeholders can be used: UserID, OrgID, CodeID, Code
Body
required
sendLink
object
Possible values: non-empty
and <= 200 characters
Optionally set a url_template, which will be used in the mail sent by ZITADEL to guide the user to your passkey registration page. If no template is set, the default ZITADEL url will be used.
The following placeholders can be used: UserID, OrgID, CodeID, Code
Responses​
- 200
- 403
- 404
- default
OK
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
code
object
"one time code generated by ZITADEL; required to start the passkey registration without user authentication"
Possible values: <= 200 characters
"id to the one time code generated by ZITADEL"
Possible values: <= 200 characters
"one time code generated by ZITADEL"
{
"details": {
"sequence": "2",
"changeDate": "2024-12-20T16:04:43.990Z",
"resourceOwner": "69629023906488334"
},
"code": {
"id": "e2a48d6a-362b-4db6-a1fb-34feab84dc62",
"code": "SomeSpecialCode"
}
}
- Schema
- Example (from schema)
Schema
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
code
object
"one time code generated by ZITADEL; required to start the passkey registration without user authentication"
Possible values: <= 200 characters
"id to the one time code generated by ZITADEL"
Possible values: <= 200 characters
"one time code generated by ZITADEL"
{
"details": {
"sequence": "2",
"changeDate": "2024-12-20T16:04:43.991Z",
"resourceOwner": "69629023906488334"
},
"code": {
"id": "e2a48d6a-362b-4db6-a1fb-34feab84dc62",
"code": "SomeSpecialCode"
}
}
- Schema
- Example (from schema)
Schema
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
code
object
"one time code generated by ZITADEL; required to start the passkey registration without user authentication"
Possible values: <= 200 characters
"id to the one time code generated by ZITADEL"
Possible values: <= 200 characters
"one time code generated by ZITADEL"
{
"details": {
"sequence": "2",
"changeDate": "2024-12-20T16:04:43.991Z",
"resourceOwner": "69629023906488334"
},
"code": {
"id": "e2a48d6a-362b-4db6-a1fb-34feab84dc62",
"code": "SomeSpecialCode"
}
}
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
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
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
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
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
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}