authentication
Login
Authenticate one personal account and select its sole accessible organization.
POST
/
v1
/
auth
/
login
Login
curl --request POST \
--url https://api.aixy-gateway.com/v1/auth/login \
--header 'Content-Type: application/json' \
--data '
{
"email": "[email protected]",
"password": "<string>"
}
'import requests
url = "https://api.aixy-gateway.com/v1/auth/login"
payload = {
"email": "[email protected]",
"password": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({email: '[email protected]', password: '<string>'})
};
fetch('https://api.aixy-gateway.com/v1/auth/login', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"person": {
"id": "<string>",
"email": "<string>",
"name": "<string>"
},
"organizations": [
{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"user_id": "<string>",
"role": "<string>",
"authentication_required": "sso"
}
],
"account": {
"organization": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"object": "organization"
},
"user": {
"id": "<string>",
"organization_id": "<string>",
"email": "<string>",
"name": "<string>",
"role": "<string>",
"project_ids": [
"<string>"
],
"object": "organization.user",
"role_label": "<string>"
},
"permissions": [
"<string>"
],
"expires_at": "<string>"
},
"expires_at": "<string>",
"organization": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"object": "organization"
},
"user": {
"id": "<string>",
"organization_id": "<string>",
"email": "<string>",
"name": "<string>",
"role": "<string>",
"project_ids": [
"<string>"
],
"object": "organization.user",
"role_label": "<string>"
},
"permissions": [
"<string>"
],
"object": "auth.session"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Body
application/json
Response
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Allowed value:
"auth.session"⌘I
Login
curl --request POST \
--url https://api.aixy-gateway.com/v1/auth/login \
--header 'Content-Type: application/json' \
--data '
{
"email": "[email protected]",
"password": "<string>"
}
'import requests
url = "https://api.aixy-gateway.com/v1/auth/login"
payload = {
"email": "[email protected]",
"password": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({email: '[email protected]', password: '<string>'})
};
fetch('https://api.aixy-gateway.com/v1/auth/login', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"person": {
"id": "<string>",
"email": "<string>",
"name": "<string>"
},
"organizations": [
{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"user_id": "<string>",
"role": "<string>",
"authentication_required": "sso"
}
],
"account": {
"organization": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"object": "organization"
},
"user": {
"id": "<string>",
"organization_id": "<string>",
"email": "<string>",
"name": "<string>",
"role": "<string>",
"project_ids": [
"<string>"
],
"object": "organization.user",
"role_label": "<string>"
},
"permissions": [
"<string>"
],
"expires_at": "<string>"
},
"expires_at": "<string>",
"organization": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"object": "organization"
},
"user": {
"id": "<string>",
"organization_id": "<string>",
"email": "<string>",
"name": "<string>",
"role": "<string>",
"project_ids": [
"<string>"
],
"object": "organization.user",
"role_label": "<string>"
},
"permissions": [
"<string>"
],
"object": "auth.session"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}