Start a WebAuthN registration

POST 
/resources/v3alpha/users/:id/webauthn

Start the registration of a new WebAuthN device (e.g. Passkeys) for a user. As a response the public key credential creation options are returned, which are used to verify the device.

Request

Path Parameters

id stringrequired

unique identifier of the user.

Query Parameters

instance.id string
instance.domain string
organization.orgId string
organization.orgDomain string

application/json

Body

required

domain stringrequired

Possible values: non-empty and <= 200 characters

Domain on which the user currently is or will be authenticated.

authenticatorType string

Possible values: [WEB_AUTH_N_AUTHENTICATOR_UNSPECIFIED, WEB_AUTH_N_AUTHENTICATOR_PLATFORM, WEB_AUTH_N_AUTHENTICATOR_CROSS_PLATFORM]

Default value: WEB_AUTH_N_AUTHENTICATOR_UNSPECIFIED

Optionally specify the authenticator type of the passkey device (platform or cross-platform). If none is provided, both values are allowed.

code

object

Optionally provide a one time code generated by ZITADEL. This is required to start the passkey registration without user authentication.

id stringrequired

Possible values: non-empty and <= 200 characters

ID to the one time code generated by ZITADEL.

code stringrequired

Possible values: non-empty and <= 200 characters

one time code generated by ZITADEL.

application/grpc

Body

required

domain stringrequired

Possible values: non-empty and <= 200 characters

Domain on which the user currently is or will be authenticated.

authenticatorType string

Possible values: [WEB_AUTH_N_AUTHENTICATOR_UNSPECIFIED, WEB_AUTH_N_AUTHENTICATOR_PLATFORM, WEB_AUTH_N_AUTHENTICATOR_CROSS_PLATFORM]

Default value: WEB_AUTH_N_AUTHENTICATOR_UNSPECIFIED

Optionally specify the authenticator type of the passkey device (platform or cross-platform). If none is provided, both values are allowed.

code

object

Optionally provide a one time code generated by ZITADEL. This is required to start the passkey registration without user authentication.

id stringrequired

Possible values: non-empty and <= 200 characters

ID to the one time code generated by ZITADEL.

code stringrequired

Possible values: non-empty and <= 200 characters

one time code generated by ZITADEL.

application/grpc-web+proto

Body

required

domain stringrequired

Possible values: non-empty and <= 200 characters

Domain on which the user currently is or will be authenticated.

authenticatorType string

Possible values: [WEB_AUTH_N_AUTHENTICATOR_UNSPECIFIED, WEB_AUTH_N_AUTHENTICATOR_PLATFORM, WEB_AUTH_N_AUTHENTICATOR_CROSS_PLATFORM]

Default value: WEB_AUTH_N_AUTHENTICATOR_UNSPECIFIED

Optionally specify the authenticator type of the passkey device (platform or cross-platform). If none is provided, both values are allowed.

code

object

Optionally provide a one time code generated by ZITADEL. This is required to start the passkey registration without user authentication.

id stringrequired

Possible values: non-empty and <= 200 characters

ID to the one time code generated by ZITADEL.

code stringrequired

Possible values: non-empty and <= 200 characters

one time code generated by ZITADEL.

Responses

200

WebAuthN registration successfully started

application/json

Schema

Schema

details

object

id string

created date-time

the timestamp of the first event applied to the object.

changed date-time

the timestamp of the last event applied to the object.

owner

object

the parent object representing the returned objects context.

type string

Possible values: [OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_SYSTEM, OWNER_TYPE_INSTANCE, OWNER_TYPE_ORG]

Default value: OWNER_TYPE_UNSPECIFIED

id string
webAuthNId string

unique identifier of the WebAuthN registration.

publicKeyCredentialCreationOptions object

Example (from schema)

{
  "details": {
    "id": "69629012906488334",
    "created": "2024-11-22T16:27:05.703Z",
    "changed": "2024-11-22T16:27:05.703Z",
    "owner": "69629023906488334"
  },
  "webAuthNId": "163840776835432705",
  "publicKeyCredentialCreationOptions": {
    "publicKey": {
      "attestation": "none",
      "authenticatorSelection": {
        "userVerification": "required"
      },
      "challenge": "XaMYwWOZ5hj6pwtwJJlpcI-ExkO5TxevBMG4R8DoKQQ",
      "excludeCredentials": [
        {
          "id": "tVp1QfYhT8DkyEHVrv7blnpAo2YJzbZgZNBf7zPs6CI",
          "type": "public-key"
        }
      ],
      "pubKeyCredParams": [
        {
          "alg": -7,
          "type": "public-key"
        }
      ],
      "rp": {
        "id": "localhost",
        "name": "ZITADEL"
      },
      "timeout": 300000,
      "user": {
        "displayName": "Tim Mohlmann",
        "id": "MjE1NTk4MDAwNDY0OTk4OTQw",
        "name": "tim"
      }
    }
  }
}

application/grpc

Schema

Schema

details

object

id string

created date-time

the timestamp of the first event applied to the object.

changed date-time

the timestamp of the last event applied to the object.

owner

object

the parent object representing the returned objects context.

type string

Possible values: [OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_SYSTEM, OWNER_TYPE_INSTANCE, OWNER_TYPE_ORG]

Default value: OWNER_TYPE_UNSPECIFIED

id string
webAuthNId string

unique identifier of the WebAuthN registration.

publicKeyCredentialCreationOptions object

Example (from schema)

{
  "details": {
    "id": "69629012906488334",
    "created": "2024-11-22T16:27:05.703Z",
    "changed": "2024-11-22T16:27:05.703Z",
    "owner": "69629023906488334"
  },
  "webAuthNId": "163840776835432705",
  "publicKeyCredentialCreationOptions": {
    "publicKey": {
      "attestation": "none",
      "authenticatorSelection": {
        "userVerification": "required"
      },
      "challenge": "XaMYwWOZ5hj6pwtwJJlpcI-ExkO5TxevBMG4R8DoKQQ",
      "excludeCredentials": [
        {
          "id": "tVp1QfYhT8DkyEHVrv7blnpAo2YJzbZgZNBf7zPs6CI",
          "type": "public-key"
        }
      ],
      "pubKeyCredParams": [
        {
          "alg": -7,
          "type": "public-key"
        }
      ],
      "rp": {
        "id": "localhost",
        "name": "ZITADEL"
      },
      "timeout": 300000,
      "user": {
        "displayName": "Tim Mohlmann",
        "id": "MjE1NTk4MDAwNDY0OTk4OTQw",
        "name": "tim"
      }
    }
  }
}

application/grpc-web+proto

Schema

Schema

details

object

id string

created date-time

the timestamp of the first event applied to the object.

changed date-time

the timestamp of the last event applied to the object.

owner

object

the parent object representing the returned objects context.

type string

Possible values: [OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_SYSTEM, OWNER_TYPE_INSTANCE, OWNER_TYPE_ORG]

Default value: OWNER_TYPE_UNSPECIFIED

id string
webAuthNId string

unique identifier of the WebAuthN registration.

publicKeyCredentialCreationOptions object

Example (from schema)

{
  "details": {
    "id": "69629012906488334",
    "created": "2024-11-22T16:27:05.703Z",
    "changed": "2024-11-22T16:27:05.703Z",
    "owner": "69629023906488334"
  },
  "webAuthNId": "163840776835432705",
  "publicKeyCredentialCreationOptions": {
    "publicKey": {
      "attestation": "none",
      "authenticatorSelection": {
        "userVerification": "required"
      },
      "challenge": "XaMYwWOZ5hj6pwtwJJlpcI-ExkO5TxevBMG4R8DoKQQ",
      "excludeCredentials": [
        {
          "id": "tVp1QfYhT8DkyEHVrv7blnpAo2YJzbZgZNBf7zPs6CI",
          "type": "public-key"
        }
      ],
      "pubKeyCredParams": [
        {
          "alg": -7,
          "type": "public-key"
        }
      ],
      "rp": {
        "id": "localhost",
        "name": "ZITADEL"
      },
      "timeout": 300000,
      "user": {
        "displayName": "Tim Mohlmann",
        "id": "MjE1NTk4MDAwNDY0OTk4OTQw",
        "name": "tim"
      }
    }
  }
}

403

Returned when the user does not have permission to access the resource.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

404

Returned when the resource does not exist.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...