Browse content
Fireback - User authentication built for you. Get your license

Passport http reference

User-flow built for you.

getPassports

/passports

Response Dto/Entity: *[]passports.PassportEntity

message PassportEntity {
    string type = 1; // @tag(json:"type" validate:"required")
	string value   = 2; // @tag(json:"value" gorm:"unique" validate:"required")
	string password    = 3; // @tag(json:"-")
	bool   confirmed   = 4; // @tag(json:"confirmed")
	string accessToken = 5; // @tag(json:"accessToken")
	string userId      = 6; // @tag(json:"userId" validate:"required")
	string uniqueId    = 7; // @tag(json:"uniqueId" gorm:"primarykey;uniqueId;unique;not null;size:100;")
}

export interface PassportEntity {
    /** @tag(json:"type" validate:"required") */
    type: string;
    /** @tag(json:"value" gorm:"unique" validate:"required") */
    value: string;
    /** @tag(json:"-") */
    password: string;
    /** @tag(json:"confirmed") */
    confirmed: boolean;
    /** @tag(json:"accessToken") */
    accessToken: string;
    /** @tag(json:"userId" validate:"required") */
    userId: string;
    /** @tag(json:"uniqueId" gorm:"primarykey;uniqueId;unique;not null;size:100;") */
    uniqueId: string;
}

getPassportById

/passport/:id

Response Dto/Entity: *passports.PassportEntity

message PassportEntity {
    string type = 1; // @tag(json:"type" validate:"required")
	string value   = 2; // @tag(json:"value" gorm:"unique" validate:"required")
	string password    = 3; // @tag(json:"-")
	bool   confirmed   = 4; // @tag(json:"confirmed")
	string accessToken = 5; // @tag(json:"accessToken")
	string userId      = 6; // @tag(json:"userId" validate:"required")
	string uniqueId    = 7; // @tag(json:"uniqueId" gorm:"primarykey;uniqueId;unique;not null;size:100;")
}

export interface PassportEntity {
    /** @tag(json:"type" validate:"required") */
    type: string;
    /** @tag(json:"value" gorm:"unique" validate:"required") */
    value: string;
    /** @tag(json:"-") */
    password: string;
    /** @tag(json:"confirmed") */
    confirmed: boolean;
    /** @tag(json:"accessToken") */
    accessToken: string;
    /** @tag(json:"userId" validate:"required") */
    userId: string;
    /** @tag(json:"uniqueId" gorm:"primarykey;uniqueId;unique;not null;size:100;") */
    uniqueId: string;
}

Params: :id

postPassport

/passport

Response Dto/Entity: *passports.PassportEntity

message PassportEntity {
    string type = 1; // @tag(json:"type" validate:"required")
	string value   = 2; // @tag(json:"value" gorm:"unique" validate:"required")
	string password    = 3; // @tag(json:"-")
	bool   confirmed   = 4; // @tag(json:"confirmed")
	string accessToken = 5; // @tag(json:"accessToken")
	string userId      = 6; // @tag(json:"userId" validate:"required")
	string uniqueId    = 7; // @tag(json:"uniqueId" gorm:"primarykey;uniqueId;unique;not null;size:100;")
}

export interface PassportEntity {
    /** @tag(json:"type" validate:"required") */
    type: string;
    /** @tag(json:"value" gorm:"unique" validate:"required") */
    value: string;
    /** @tag(json:"-") */
    password: string;
    /** @tag(json:"confirmed") */
    confirmed: boolean;
    /** @tag(json:"accessToken") */
    accessToken: string;
    /** @tag(json:"userId" validate:"required") */
    userId: string;
    /** @tag(json:"uniqueId" gorm:"primarykey;uniqueId;unique;not null;size:100;") */
    uniqueId: string;
}

Request Dto/Entity: *passports.PassportEntity

message PassportEntity {
    string type = 1; // @tag(json:"type" validate:"required")
	string value   = 2; // @tag(json:"value" gorm:"unique" validate:"required")
	string password    = 3; // @tag(json:"-")
	bool   confirmed   = 4; // @tag(json:"confirmed")
	string accessToken = 5; // @tag(json:"accessToken")
	string userId      = 6; // @tag(json:"userId" validate:"required")
	string uniqueId    = 7; // @tag(json:"uniqueId" gorm:"primarykey;uniqueId;unique;not null;size:100;")
}

export interface PassportEntity {
    /** @tag(json:"type" validate:"required") */
    type: string;
    /** @tag(json:"value" gorm:"unique" validate:"required") */
    value: string;
    /** @tag(json:"-") */
    password: string;
    /** @tag(json:"confirmed") */
    confirmed: boolean;
    /** @tag(json:"accessToken") */
    accessToken: string;
    /** @tag(json:"userId" validate:"required") */
    userId: string;
    /** @tag(json:"uniqueId" gorm:"primarykey;uniqueId;unique;not null;size:100;") */
    uniqueId: string;
}

patchPassportById

/passport/:id

Response Dto/Entity: *passports.PassportEntity

message PassportEntity {
    string type = 1; // @tag(json:"type" validate:"required")
	string value   = 2; // @tag(json:"value" gorm:"unique" validate:"required")
	string password    = 3; // @tag(json:"-")
	bool   confirmed   = 4; // @tag(json:"confirmed")
	string accessToken = 5; // @tag(json:"accessToken")
	string userId      = 6; // @tag(json:"userId" validate:"required")
	string uniqueId    = 7; // @tag(json:"uniqueId" gorm:"primarykey;uniqueId;unique;not null;size:100;")
}

export interface PassportEntity {
    /** @tag(json:"type" validate:"required") */
    type: string;
    /** @tag(json:"value" gorm:"unique" validate:"required") */
    value: string;
    /** @tag(json:"-") */
    password: string;
    /** @tag(json:"confirmed") */
    confirmed: boolean;
    /** @tag(json:"accessToken") */
    accessToken: string;
    /** @tag(json:"userId" validate:"required") */
    userId: string;
    /** @tag(json:"uniqueId" gorm:"primarykey;uniqueId;unique;not null;size:100;") */
    uniqueId: string;
}

Request Dto/Entity: *passports.PassportEntity

message PassportEntity {
    string type = 1; // @tag(json:"type" validate:"required")
	string value   = 2; // @tag(json:"value" gorm:"unique" validate:"required")
	string password    = 3; // @tag(json:"-")
	bool   confirmed   = 4; // @tag(json:"confirmed")
	string accessToken = 5; // @tag(json:"accessToken")
	string userId      = 6; // @tag(json:"userId" validate:"required")
	string uniqueId    = 7; // @tag(json:"uniqueId" gorm:"primarykey;uniqueId;unique;not null;size:100;")
}

export interface PassportEntity {
    /** @tag(json:"type" validate:"required") */
    type: string;
    /** @tag(json:"value" gorm:"unique" validate:"required") */
    value: string;
    /** @tag(json:"-") */
    password: string;
    /** @tag(json:"confirmed") */
    confirmed: boolean;
    /** @tag(json:"accessToken") */
    accessToken: string;
    /** @tag(json:"userId" validate:"required") */
    userId: string;
    /** @tag(json:"uniqueId" gorm:"primarykey;uniqueId;unique;not null;size:100;") */
    uniqueId: string;
}

Params: :id

deletePassportById

/passport/:id

Target Entity: *passports.PassportEntity

message PassportEntity {
    string type = 1; // @tag(json:"type" validate:"required")
	string value   = 2; // @tag(json:"value" gorm:"unique" validate:"required")
	string password    = 3; // @tag(json:"-")
	bool   confirmed   = 4; // @tag(json:"confirmed")
	string accessToken = 5; // @tag(json:"accessToken")
	string userId      = 6; // @tag(json:"userId" validate:"required")
	string uniqueId    = 7; // @tag(json:"uniqueId" gorm:"primarykey;uniqueId;unique;not null;size:100;")
}

export interface PassportEntity {
    /** @tag(json:"type" validate:"required") */
    type: string;
    /** @tag(json:"value" gorm:"unique" validate:"required") */
    value: string;
    /** @tag(json:"-") */
    password: string;
    /** @tag(json:"confirmed") */
    confirmed: boolean;
    /** @tag(json:"accessToken") */
    accessToken: string;
    /** @tag(json:"userId" validate:"required") */
    userId: string;
    /** @tag(json:"uniqueId" gorm:"primarykey;uniqueId;unique;not null;size:100;") */
    uniqueId: string;
}

Params: :id

postPassportSignupEmail

/passport/signup/email

Response Dto/Entity: *passports.UserSessionDto

message UserSessionDto {
    PassportEntity passport = 1;
    string token = 2;
    string exchangeKey = 3;
    repeated UserRoleWorkspace userRoleWorkspaces = 4;// @tag(json:"userRoleWorkspaces")
    UserEntity user   = 5;
}

export interface UserSessionDto {
    passport: PassportEntity | undefined;
    token: string;
    exchangeKey: string;
    /** @tag(json:"userRoleWorkspaces") */
    userRoleWorkspaces: UserRoleWorkspace[];
    user: UserEntity | undefined;
}

Request Dto/Entity: *passports.EmailAccountSignupDto

message EmailAccountSignupDto {
    string email = 1; // @tag(validate:"required") 
    string password = 2; // @tag(validate:"required")
}

export interface EmailAccountSignupDto {
    /** @tag(validate:"required") */
    email: string;
    /** @tag(validate:"required") */
    password: string;
}

postPassportSigninEmail

/passport/signin/email

Response Dto/Entity: *passports.UserSessionDto

message UserSessionDto {
    PassportEntity passport = 1;
    string token = 2;
    string exchangeKey = 3;
    repeated UserRoleWorkspace userRoleWorkspaces = 4;// @tag(json:"userRoleWorkspaces")
    UserEntity user   = 5;
}

export interface UserSessionDto {
    passport: PassportEntity | undefined;
    token: string;
    exchangeKey: string;
    /** @tag(json:"userRoleWorkspaces") */
    userRoleWorkspaces: UserRoleWorkspace[];
    user: UserEntity | undefined;
}

Request Dto/Entity: *passports.EmailAccountSigninDto

message EmailAccountSigninDto {
    string email = 1; // @tag(validate:"required") 
    string password = 2; // @tag(validate:"required")
}

export interface EmailAccountSigninDto {
    /** @tag(validate:"required") */
    email: string;
    /** @tag(validate:"required") */
    password: string;
}

postPassportSignupPhoneNumber

/passport/signup/phoneNumber

Response Dto/Entity: *core.OkayResponse

Request Dto/Entity: *passports.PhoneNumberAccountCreationDto

message PhoneNumberAccountCreationDto {
    string phoneNumber = 1; // @tag(validate:"required") 
}

export interface PhoneNumberAccountCreationDto {
    /** @tag(validate:"required") */
    phoneNumber: string;
}

postPassportSignupPhoneNumberConfirm

/passport/signup/phoneNumberConfirm

Response Dto/Entity: *core.OkayResponse

Request Dto/Entity: *passports.PhoneNumberAccountCreationDto

message PhoneNumberAccountCreationDto {
    string phoneNumber = 1; // @tag(validate:"required") 
}

export interface PhoneNumberAccountCreationDto {
    /** @tag(validate:"required") */
    phoneNumber: string;
}

postPassportSigninPhoneNumber

/passport/signin/phoneNumber

Response Dto/Entity: *passports.UserSessionDto

message UserSessionDto {
    PassportEntity passport = 1;
    string token = 2;
    string exchangeKey = 3;
    repeated UserRoleWorkspace userRoleWorkspaces = 4;// @tag(json:"userRoleWorkspaces")
    UserEntity user   = 5;
}

export interface UserSessionDto {
    passport: PassportEntity | undefined;
    token: string;
    exchangeKey: string;
    /** @tag(json:"userRoleWorkspaces") */
    userRoleWorkspaces: UserRoleWorkspace[];
    user: UserEntity | undefined;
}

Request Dto/Entity: *passports.PhoneNumberAccountCreationDto

message PhoneNumberAccountCreationDto {
    string phoneNumber = 1; // @tag(validate:"required") 
}

export interface PhoneNumberAccountCreationDto {
    /** @tag(validate:"required") */
    phoneNumber: string;
}

postConfirmEmailById

/confirm/email/:id

Response Dto/Entity: *core.OkayResponse

Request Dto/Entity: *core.EmptyRequest

Params: :id

postPassportRequestResetMailPassword

/passport/request-reset-mail-password

Response Dto/Entity: *passports.EmailOtpResponse

message EmailOtpResponse {
    ForgetPasswordEntity request = 1;
	UserSessionDto userSession = 2;
}

export interface EmailOtpResponse {
    request: ForgetPasswordEntity | undefined;
    userSession: UserSessionDto | undefined;
}

Request Dto/Entity: *passports.OtpAuthenticateDto

message OtpAuthenticateDto {
    string value = 1; // @tag(validate:"required")
	string otp = 2;
    string type = 3; // @tag(validate:"required")
}

export interface OtpAuthenticateDto {
    /** @tag(validate:"required") */
    value: string;
    otp: string;
    /** @tag(validate:"required") */
    type: string;
}

postPassportResetMailPasswordById

/passport/reset-mail-password/:id

Response Dto/Entity: *passports.UserSessionDto

message UserSessionDto {
    PassportEntity passport = 1;
    string token = 2;
    string exchangeKey = 3;
    repeated UserRoleWorkspace userRoleWorkspaces = 4;// @tag(json:"userRoleWorkspaces")
    UserEntity user   = 5;
}

export interface UserSessionDto {
    passport: PassportEntity | undefined;
    token: string;
    exchangeKey: string;
    /** @tag(json:"userRoleWorkspaces") */
    userRoleWorkspaces: UserRoleWorkspace[];
    user: UserEntity | undefined;
}

Request Dto/Entity: *passports.ResetEmailDto

message ResetEmailDto {
    string password = 1;
}

export interface ResetEmailDto {
    password: string;
}

Params: :id

getPassportRequestResetMailPassword

/passport/request-reset-mail-password

Response Dto/Entity: *core.OkayResponse

Request Dto/Entity: *core.EmptyRequest

getPassportResetMailPasswordInfoById

/passport/reset-mail-password-info/:id

Response Dto/Entity: *core.OkayResponse

Request Dto/Entity: *core.EmptyRequest

Params: :id

Ali Torabi

Software Engineer

Ali Torabi's github account
My name is Ali Torabi, I am a software engineer who is highly interested in JavaScript, Golang and C++. I serve clients, build projects and create content and videos. Started programming in primary school, still at age of 30 it's main activity I do.