LogoLogo
Go ToJoin the Community
  • Getting Started
    • Introduction
    • How it Works
    • Onboarding
  • Examples
    • Tutorials
      • Hello, World!
      • Image Generation w/ Stable Diffusion
  • CREATE WITH BYTENITE
    • Building Blocks
      • Apps
      • Job Templates
  • SDK
    • ByteNite Dev CLI
  • Launch with ByteNite
    • Data Sources
      • AWS S3
      • Google Cloud Storage
      • Storj
      • HTTP
      • File Upload
      • Temporary Bucket
    • Jobs
  • API Reference
    • Customer API
      • Jobs
        • Create
        • Read
        • Update
        • Manage
        • Other
      • Logs
      • Data Sources
      • Templates
      • Events
    • Authentication API
      • Access Token
      • API Keys
      • Secrets
      • User
    • Developer API
      • Apps
        • Metadata
        • Push
        • Manage
        • Pull
      • Engines
        • Metadata
        • Push
        • Manage
        • Pull
      • Templates
    • Wallet API
      • Balance
      • Transactions
      • Exchange Rate
      • Redeem Coupon
  • GUI
  • Other
    • Glossary
    • Feature Requests
    • Status
Powered by GitBook

© 2025 ByteNite Inc.

On this page

Was this helpful?

Export as PDF
  1. API Reference
  2. Authentication API

User

PreviousSecretsNextDeveloper API

Last updated 11 days ago

Was this helpful?



Generic information about user

get

Get id, email, name, image and activation status

Authorizations
Responses
200
A successful response.
400
Returned when the users sends a malformed request.
401
Returned when the user is not authenticated.
403
Returned when the user does not have permission to access the resource.
404
Returned when the resource does not exist.
500
Returned when an error on the server occurred.
503
Returned when the resource is temporarily unavailable.
default
An unexpected error 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"
    }
  }
}
  • GETGeneric information about user
  • PATCHSet user info

Set user info

patch

Set editable user info

Authorizations
Body
firstNamestringOptionalExample: John
lastNamestringOptionalExample: Doe
Responses
200
A successful response.
400
Returned when the users sends a malformed request.
401
Returned when the user is not authenticated.
403
Returned when the user does not have permission to access the resource.
404
Returned when the resource does not exist.
500
Returned when an error on the server occurred.
503
Returned when the resource is temporarily unavailable.
default
An unexpected error 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"
    }
  }
}