사용자 이메일 주소 API

사용자 계정의 이메일 주소를 나열, 조회, 추가, 삭제하는 API.

이 API를 사용하여 사용자 계정의 이메일 주소와 상호 작용합니다. 자세한 내용은 사용자 계정 을 참조하세요. 모든 이메일 주소 나열 # 사용자 계정의 모든 이메일 주소를 나열합니다. 필수 요건: 인증되어 있어야 합니다. GET /user/emails 예시 응답: [ { "id" : 1 , "email" : "email@example.com" , "confirmed_at" : "2021-03-26T19:07:56.248Z" } , { "id" : 3 , "email" : "email2@example.com" , "confirmed_at" : null } ] 사용자의 모든 이메일 주소 나열 # 지정된 사용자 계정의 모든 이메일 주소를 나열합니다. 필수 요건: 인스턴스에 대한 관리자 액세스가 있어야 합니다. GET /users/:id/emails 지원되는 속성: 속성 유형 필수 여부 설명 id 정수 yes 사용자 계정의 ID 이메일 주소 세부 정보 가져오기 # 사용자 계정의 지정된 이메일 주소에 대한 세부 정보를 가져옵니다. GET /user/emails/:email_id 지원되는 속성: 속성 유형 필수 여부 설명 email_id 정수 yes 이메일 주소의 ID 예시 응답: { "id" : 1 , "email" : "email@example.com" , "confirmed_at" : "2021-03-26T19:07:56.248Z" } 이메일 주소 추가 # 사용자 계정에 이메일 주소를 추가합니다. POST /user/emails 지원되는 속성: 속성 유형 필수 여부 설명 email 문자열 yes 이메일 주소 { "id" : 4 , "email" : "email@example.com" , "confirmed_at" : "2021-03-26T19:07:56.248Z" } 성공 시 상태 201 Created 와 함께 생성된 이메일을 반환합니다. 오류가 발생하면 오류를 설명하는 메시지와 함께 400 Bad Request 가 반환됩니다: { "message" : { "email" : [ "has already been taken" ] } } 사용자의 이메일 주소 추가 # 지정된 사용자 계정에 이메일 주소를 추가합니다. 필수 요건: 인스턴스에 대한 관리자 액세스가 있어야 합니다. POST /users/:id/emails 지원되는 속성: 속성 유형 필수 여부 설명 id 문자열 yes 사용자 계정의 ID email 문자열 yes 이메일 주소 skip_confirmation 불리언 no 확인을 건너뛰고 이메일이 확인된 것으로 가정합니다. 가능한 값: true , false . 기본값: false . 이메일 주소 삭제 # 사용자 계정의 이메일 주소를 삭제합니다. 기본 이메일 주소는 삭제할 수 없습니다. 삭제된 이메일 주소로 보내는 이후 이메일은 기본 이메일 주소로 전송됩니다. 필수 요건: 인증되어 있어야 합니다. DELETE /user/emails/:email_id 지원되는 속성: 속성 유형 필수 여부 설명 email_id 정수 yes 이메일 주소의 ID 반환