Skip to content
Tallyraydocs

Sign in with an email and a password, in the account named, else the one last used, else the first

POST
/v1/auth/sign-in
curl --request POST \
  --url https://example.com/v1/auth/sign-in \
  --header 'Content-Type: application/json' \
  --data '{ "account": "example", "email": "example", "password": "example" }'

Who: anyone.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
account
string
email
required
string
password
required
string

Example generated

{
  "account": "example",
  "email": "example",
  "password": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
access_token
required
string
access_token_expires_at
required
string format: date-time
membership
required
object
account
required
object
id
integer format: int64
kind
required
string | null
Allowed values: network affiliate advertiser service workspace
account_name
required
string
created_at
required
string | null format: date-time
created_by
required
Any of:
object
account
string
id
string
kind
required
string | null
Allowed values: user api_key service system postback rule tuner schedule
name
string
id
string
owner
required
boolean
role
required
string | null
Allowed values: admin manager affiliate advertiser buyer viewer support
status
required
string | null
Allowed values: invited active
updated_at
required
string | null format: date-time
user
Any of:
object
created_at
required
string format: date-time
created_by
required
Any of:
object
account
string
id
string
kind
required
string | null
Allowed values: user api_key service system postback rule tuner schedule
name
string
email
required
string
email_verified_at
required
string | null format: date-time
id
required
string
last_signed_in_at
required
string | null format: date-time
name
required
string
status
required
string | null
Allowed values: invited unverified active disabled
time_zone
required
string
updated_at
required
string format: date-time
user_id
required
string
refresh_token
required
string
refresh_token_expires_at
required
string format: date-time
user
required
object
created_at
required
string format: date-time
created_by
required
Any of:
object
account
string
id
string
kind
required
string | null
Allowed values: user api_key service system postback rule tuner schedule
name
string
email
required
string
email_verified_at
required
string | null format: date-time
id
required
string
last_signed_in_at
required
string | null format: date-time
name
required
string
status
required
string | null
Allowed values: invited unverified active disabled
time_zone
required
string
updated_at
required
string format: date-time

Example 

{
  "membership": {
    "account": {
      "kind": "network"
    },
    "created_by": {
      "kind": "user"
    },
    "role": "admin",
    "status": "invited",
    "user": {
      "created_by": {
        "kind": "user"
      },
      "status": "invited"
    }
  },
  "user": {
    "created_by": {
      "kind": "user"
    },
    "status": "invited"
  }
}

default

Section titled “default”

An error, as go-commons apperr maps it

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string

Example generated

{
  "error": {
    "code": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}