logo

Create a session with username and password

Creates a session with a specified username and password.

SecurityPublishableApiKey
Request
Request Body schema: application/json
username
required
string

User's username.

password
required
string

User's current password.

Responses
201

Logged into account.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
id
string <= 50 characters

ID of the session.

token
string

Session's token used for authentication.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

expiredTime
string <date-time>

Session expired time. Defaults to one hour.

401

Unauthorized access. Invalid credentials used.

post/storefront/login
Request samples
application/json
{
  • "username": "string",
  • "password": "string"
}
Response samples
application/json
{
  • "id": "jwt_0YV7DEJX80CDRAKVTV478ZNJDR",
  • "token": "string",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "expiredTime": "2019-08-24T14:15:22Z"
}
➔ Next to Destroys the user's current session