Add One-Time-Password (OTP)
Add a new One-Time-Password (OTP) factor to the authenticated user. OTP is an authenticator app like Google/Microsoft Authenticator, Authy, etc. Only one OTP per user is allowed. After adding a new OTP it has to be verified.
- application/json
- application/grpc
- application/grpc-web+proto
Request Body required
- object
Request Body required
- object
Request Body required
- object
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- url string
- secret string
- details objectsequence uint64- on read: the sequence of the last event reduced by the projection - on manipulation: the timestamp of the event(s) added by the manipulation creationDate date-time- on read: the timestamp of the first event of the object - on create: the timestamp of the event(s) added by the manipulation changeDate date-time- on read: the timestamp of the last event reduced by the projection - on manipulation: the resourceOwner resource_owner is the organization an object belongs to
{
  "url": "otpauth://totp/ZITADEL:gigi@acme.zitadel.cloud?algorithm=SHA1&digits=6&issuer=ZITADEL&period=30&secret=TJOPWSDYILLHXFV4MLKNNJOWFG7VSDCK",
  "secret": "TJOPWSDYILLHXFV4MLKNNJOWFG7VSDCK",
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-10",
    "changeDate": "2023-05-10",
    "resourceOwner": "69629023906488334"
  }
}
- Schema
- Example (from schema)
Schema
- url string
- secret string
- details objectsequence uint64- on read: the sequence of the last event reduced by the projection - on manipulation: the timestamp of the event(s) added by the manipulation creationDate date-time- on read: the timestamp of the first event of the object - on create: the timestamp of the event(s) added by the manipulation changeDate date-time- on read: the timestamp of the last event reduced by the projection - on manipulation: the resourceOwner resource_owner is the organization an object belongs to
{
  "url": "otpauth://totp/ZITADEL:gigi@acme.zitadel.cloud?algorithm=SHA1&digits=6&issuer=ZITADEL&period=30&secret=TJOPWSDYILLHXFV4MLKNNJOWFG7VSDCK",
  "secret": "TJOPWSDYILLHXFV4MLKNNJOWFG7VSDCK",
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-10",
    "changeDate": "2023-05-10",
    "resourceOwner": "69629023906488334"
  }
}
- Schema
- Example (from schema)
Schema
- url string
- secret string
- details objectsequence uint64- on read: the sequence of the last event reduced by the projection - on manipulation: the timestamp of the event(s) added by the manipulation creationDate date-time- on read: the timestamp of the first event of the object - on create: the timestamp of the event(s) added by the manipulation changeDate date-time- on read: the timestamp of the last event reduced by the projection - on manipulation: the resourceOwner resource_owner is the organization an object belongs to
{
  "url": "otpauth://totp/ZITADEL:gigi@acme.zitadel.cloud?algorithm=SHA1&digits=6&issuer=ZITADEL&period=30&secret=TJOPWSDYILLHXFV4MLKNNJOWFG7VSDCK",
  "secret": "TJOPWSDYILLHXFV4MLKNNJOWFG7VSDCK",
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-10",
    "changeDate": "2023-05-10",
    "resourceOwner": "69629023906488334"
  }
}
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"
    }
  ]
}