Create a passkey registration link for a user
Create a passkey registration link which includes a code and either return it or send it to the user.
Path Parameters
- userId string required
- application/json
- application/grpc
- application/grpc-web+proto
Request Body required
sendLink object
urlTemplate stringPossible 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."
- returnCode object
Request Body required
sendLink object
urlTemplate stringPossible 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."
- returnCode object
Request Body required
sendLink object
urlTemplate stringPossible 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."
- returnCode object
- 200
- 403
- 404
- default
OK
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs tocode object
"one time code generated by ZITADEL; required to start the passkey registration without user authentication"
id stringPossible values:
<= 200 characters
"id to the one time code generated by ZITADEL"
code stringPossible values:
<= 200 characters
"one time code generated by ZITADEL"
{
"details": {
"sequence": "2",
"changeDate": "2023-07-28",
"resourceOwner": "69629023906488334"
},
"code": {
"id": "e2a48d6a-362b-4db6-a1fb-34feab84dc62",
"code": "SomeSpecialCode"
}
}
- Schema
- Example (from schema)
Schema
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs tocode object
"one time code generated by ZITADEL; required to start the passkey registration without user authentication"
id stringPossible values:
<= 200 characters
"id to the one time code generated by ZITADEL"
code stringPossible values:
<= 200 characters
"one time code generated by ZITADEL"
{
"details": {
"sequence": "2",
"changeDate": "2023-07-28",
"resourceOwner": "69629023906488334"
},
"code": {
"id": "e2a48d6a-362b-4db6-a1fb-34feab84dc62",
"code": "SomeSpecialCode"
}
}
- Schema
- Example (from schema)
Schema
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs tocode object
"one time code generated by ZITADEL; required to start the passkey registration without user authentication"
id stringPossible values:
<= 200 characters
"id to the one time code generated by ZITADEL"
code stringPossible values:
<= 200 characters
"one time code generated by ZITADEL"
{
"details": {
"sequence": "2",
"changeDate": "2023-07-28",
"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
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"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[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"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[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}