User
Get id, email, name, image and activation status
A successful response.
Returned when the users sends a malformed request.
Returned when the user is not authenticated.
Returned when the user does not have permission to access the resource.
Returned when the resource does not exist.
Returned when an error on the server occurred.
Returned when the resource is temporarily unavailable.
An unexpected error response.
GET /v1/auth/user HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*
{
"user": {
"id": "acc2e66f-fa31-4e73-9c49-eedee36fcf32",
"createdAt": "2020-01-01T00:00:00Z",
"lastLogin": "2020-01-01T00:00:00Z",
"displayName": "John Doe",
"email": "[email protected]",
"settings": {},
"photoUrl": "https://example.com/photo.jpg",
"providerId": "google",
"emailVerified": true,
"customClaims": {
"role": "admin"
},
"role": "ROLE_NONE",
"firstName": "John",
"lastName": "Doe",
"contactInfo": {
"company": "ByteNite",
"jobTitle": "Software Engineer",
"phoneNumber": "1234567890",
"address1": "1234 Main St",
"address2": "Apt 123",
"city": "San Francisco",
"state": "CA",
"zip": "94107",
"country": "United States"
},
"disabled": false,
"isOnboarded": true,
"onboardingInfo": [
{
"step": 1,
"answer": {}
}
]
}
}
Set editable user info
John
Doe
A successful response.
Returned when the users sends a malformed request.
Returned when the user is not authenticated.
Returned when the user does not have permission to access the resource.
Returned when the resource does not exist.
Returned when an error on the server occurred.
Returned when the resource is temporarily unavailable.
An unexpected error response.
PATCH /v1/auth/user HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 297
{
"contactInfo": {
"company": "ByteNite",
"jobTitle": "Software Engineer",
"phoneNumber": "1234567890",
"address1": "1234 Main St",
"address2": "Apt 123",
"city": "San Francisco",
"state": "CA",
"zip": "94107",
"country": "United States"
},
"firstName": "John",
"lastName": "Doe",
"onboardingInfo": [
{
"step": 1,
"answer": {}
}
]
}
{
"user": {
"id": "acc2e66f-fa31-4e73-9c49-eedee36fcf32",
"createdAt": "2020-01-01T00:00:00Z",
"lastLogin": "2020-01-01T00:00:00Z",
"displayName": "John Doe",
"email": "[email protected]",
"settings": {},
"photoUrl": "https://example.com/photo.jpg",
"providerId": "google",
"emailVerified": true,
"customClaims": {
"role": "admin"
},
"role": "ROLE_NONE",
"firstName": "John",
"lastName": "Doe",
"contactInfo": {
"company": "ByteNite",
"jobTitle": "Software Engineer",
"phoneNumber": "1234567890",
"address1": "1234 Main St",
"address2": "Apt 123",
"city": "San Francisco",
"state": "CA",
"zip": "94107",
"country": "United States"
},
"disabled": false,
"isOnboarded": true,
"onboardingInfo": [
{
"step": 1,
"answer": {}
}
]
}
}
Last updated
Was this helpful?