Change the user email

POST 
/v2/users/:userId/email

Change the email address of a user. If the state is set to not verified, a verification code will be generated, which can be either returned or sent to the user by email..

Request

Path Parameters

userId stringrequired

application/json

Body

required

email stringrequired

Possible values: non-empty and <= 200 characters

sendCode

object

urlTemplate string

Possible values: non-empty and <= 200 characters

Optionally set a url_template, which will be used in the verification mail sent by ZITADEL to guide the user to your verification page. If no template is set, the default ZITADEL url will be used.

The following placeholders can be used: UserID, OrgID, Code

returnCode object
isVerified boolean

application/grpc

Body

required

email stringrequired

Possible values: non-empty and <= 200 characters

sendCode

object

urlTemplate string

Possible values: non-empty and <= 200 characters

Optionally set a url_template, which will be used in the verification mail sent by ZITADEL to guide the user to your verification page. If no template is set, the default ZITADEL url will be used.

The following placeholders can be used: UserID, OrgID, Code

returnCode object
isVerified boolean

application/grpc-web+proto

Body

required

email stringrequired

Possible values: non-empty and <= 200 characters

sendCode

object

urlTemplate string

Possible values: non-empty and <= 200 characters

Optionally set a url_template, which will be used in the verification mail sent by ZITADEL to guide the user to your verification page. If no template is set, the default ZITADEL url will be used.

The following placeholders can be used: UserID, OrgID, Code

returnCode object
isVerified boolean

Responses

200

OK

application/json

Schema

Schema

details

object

sequence 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

changeDate date-time

on 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 to (string)
verificationCode in case the verification was set to return_code, the code will be returned (string)

Example (from schema)

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-12-23T07:03:23.723Z",
    "resourceOwner": "69629023906488334"
  },
  "verificationCode": "string"
}

application/grpc

Schema

Schema

details

object

sequence 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

changeDate date-time

on 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 to (string)
verificationCode in case the verification was set to return_code, the code will be returned (string)

Example (from schema)

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-12-23T07:03:23.723Z",
    "resourceOwner": "69629023906488334"
  },
  "verificationCode": "string"
}

application/grpc-web+proto

Schema

Schema

details

object

sequence 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

changeDate date-time

on 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 to (string)
verificationCode in case the verification was set to return_code, the code will be returned (string)

Example (from schema)

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-12-23T07:03:23.723Z",
    "resourceOwner": "69629023906488334"
  },
  "verificationCode": "string"
}

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...