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
unique identifier of the user.
Request Body required
sendLink object
Let ZITADEL send the link to the user via email.
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.
Get the code back to provide it to the user in your preferred mechanism.
Request Body required
sendLink object
Let ZITADEL send the link to the user via email.
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.
Get the code back to provide it to the user in your preferred mechanism.
Request Body required
sendLink object
Let ZITADEL send the link to the user via email.
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.
Get the code back to provide it to the user in your preferred mechanism.
- 200
- 403
- 404
- default
WebAuthN registration successfully created
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
In case the medium was set to return_code, the code will be returned.
Possible values: non-empty
and <= 200 characters
ID to the one time code generated by ZITADEL.
Possible values: non-empty
and <= 200 characters
one time code generated by ZITADEL.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.397Z",
"resourceOwner": "69629023906488334"
},
"code": {
"id": "e2a48d6a-362b-4db6-a1fb-34feab84dc62",
"code": "SKJd342k"
}
}
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
In case the medium was set to return_code, the code will be returned.
Possible values: non-empty
and <= 200 characters
ID to the one time code generated by ZITADEL.
Possible values: non-empty
and <= 200 characters
one time code generated by ZITADEL.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.397Z",
"resourceOwner": "69629023906488334"
},
"code": {
"id": "e2a48d6a-362b-4db6-a1fb-34feab84dc62",
"code": "SKJd342k"
}
}
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
In case the medium was set to return_code, the code will be returned.
Possible values: non-empty
and <= 200 characters
ID to the one time code generated by ZITADEL.
Possible values: non-empty
and <= 200 characters
one time code generated by ZITADEL.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.397Z",
"resourceOwner": "69629023906488334"
},
"code": {
"id": "e2a48d6a-362b-4db6-a1fb-34feab84dc62",
"code": "SKJd342k"
}
}
Returned when the user does not have permission to access the resource.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}