User


Generic information about user

get

Get id, email, name, image and activation status

Authorizations
Responses
200
A successful response.
get
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]",
    "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"
    }
  }
}


Set user info

patch

Set editable user info

Authorizations
Body
firstNamestringOptionalExample: John
lastNamestringOptionalExample: Doe
Responses
200
A successful response.
patch
PATCH /v1/auth/user HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 255

{
  "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"
}
{
  "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]",
    "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"
    }
  }
}

Last updated

Was this helpful?