Authentication

---

• Sign up
• Sign in
• Forgot password
• Reset password
• Send Email for Verification
• Verify Email
• Sign out

Sign up

{danger} Deprecado. Usa Store Booker Store Talent

Method	URI	Headers
POST	/auth/sign-up	N/A

Payload

{
  "name": "John Doe",
  "email": "john-doe@example.io",
  "role_name": "talent",
  "password": "secret-password"
}

Ok Response

{
  "id": 1,
  "name": "John Doe",
  "email": "john-doe@example.io",
  "email_verified_at": null,
  "created_at": "2022-11-13T14:24:41.000000Z",
  "updated_at": "2022-11-13T14:24:41.000000Z",
  "deleted_at": null,
  "role_name": "admin"
}

AT01 Error

{
  "error_code": "AT01",
  "details": "The role admin is not allowed to sign up",
  "parameters": {
    "role_name": "admin"
  }
}

ER422 Error

{
  "error_code": "ER422",
  "details": "Unprocessable entity.",
  "parameters": {
    "email": "admin@admin.com"
  },
  "errors": {
    "email": [
      "The email has already been taken."
    ]
  }
}

Sign in

Method	URI	Headers
POST	/auth/sign-in	N/A

Payload

{
  "email": "john-doe@example.io",
  "role_name": "talent",
  "password": "secret-password"
}

Ok Response

{
  "user": {
    "id": 2,
    "name": "Test Case",
    "email": "test_email_address@testcase.com",
    "email_verified_at": null,
    "created_at": "2022-11-13T14:24:41.000000Z",
    "updated_at": "2022-11-13T14:24:41.000000Z",
    "deleted_at": null,
    "role_name": "talent"
  },
  "access_token": {
    "type": "Bearer",
    "token": "1|bBgQRuEcUWTNGYb6o4YpeOBZjz31oxnieKHSmOPz",
    "created_at_timestamp": 1668349481,
    "expires_at_timestamp": 2614429481
  },
  "permissions": [
    "sign-in",
    "view-Talent",
    "view-TalentPhoto",
    "view-BannerImage",
    "view-Faq"
  ]
}

Forgot Password

Method	URI	Headers
POST	/auth/forgot-password	N/A

Payload

{
  "email": "john-doe@example.io"
}

Ok Response

{
  "message": "We have emailed your password reset link!"
}

ER400 Error: user

{
  "error_code": "ER400",
  "details": "We can't find a user with that email address.",
  "parameters": null
}

ER400 Error: throttled

{
  "error_code": "ER400",
  "details": "Please wait before retrying.",
  "parameters": null
}

Reset Password

Method	URI	Headers
POST	/auth/reset-password/{token}	N/A

Payload

{
  "email": "john-doe@example.io",
  "token": "y$gOzLQ4gtIsznHOF3uT3r4eN0WTj04z3/NhQs822XU1gLx09oyWSRK",
  "password": "my-new-awesome-password"
}

Ok Response

{
  "message": "Your password has been reset!"
}

ER400 Error: token

{
  "error_code": "ER400",
  "details": "This password reset token is invalid.",
  "parameters": null
}

ER400 Error: user

{
  "error_code": "ER400",
  "details": "We can't find a user with that email address.",
  "parameters": null
}

Send Email for Verification

Method	URI	Headers
POST	/auth/send-email-verification-notification	N/A

Payload

{}

Ok Response

{
  "message": "verification link sent"
}

ER400 Error: already verified

{
  "error_code": "ER400",
  "details": "Email already verified",
  "parameters": null
}

Verify Email

Method	URI	Headers
POST	/auth/verify-email/{id}/{hash}	N/A

Payload

{
  "id": "required|integer",
  "hash": "y$gOzLQ4gtIsznHOF3uT3r4eN0WTj04z3/NhQs822XU1gLx09oyWSRK",
  "signature": "link-signature"
}

Ok Response

User

ER400 Error: already verified

{
  "error_code": "ER400",
  "details": "Email already verified",
  "parameters": null
}

ER401 Error: token invalid

{
  "error_code": "ER401",
  "details": "Invalid token",
  "parameters": null
}

Send Email for Verification

Method	URI	Headers
POST	/auth/logout	N/A

Payload

{}

Ok Response

{
  "message": "Successfully logged out"
}