# Users

Users in BLOXCity Api are separated into two categories:

Name	Description
Unauthenticated	This is the type we are talking about here
Authenticated	This will be clarified in a future update to the API Docs when OAuth2 sign in process is publicized after deemed secure

Like all other APIs Users apis are also JSON Api compliant

# Schema

A BLOXCity User is defined with the following schema that encompasses all User Object endpoints:

    interface IBLOXCityUser {
        id: string?,
        username : string,
        bio : string?,
        renders: {
            full: string?,
            headshot: string?
        }
    }

namespace Application.Domains.Entities
{
    /// <summary>
    /// Represents rendering information for a BLOXCity user.
    /// </summary>
    public class BLOXCityUserRenders
    {
        public string? Full { get; set; }
        public string? Headshot { get; set; }
    }
}

namespace Application.Domains.Entities {
    
    /// <summary>
    /// An entity represents a remote source of origin BLOXCity representing an User
    /// </summary>
    public class BLOXCityUser {
        public Guid Id {get; set;}
        public string Username {get; set;} = default!;
        public string? Bio {get; set;}
        public BLOXCityUserRenders? Renders {get; set;} = default!;
    }
}

For authenticated requests:

These fields are accepted by the user during the authorization process of your application over OAuth2, those returned fields are strictly confidential and you must keep them properly secured. Because of this some of these OAuth2 permissions require approval and security audits of your codebase

Here are fields that OAuth2 clients can access:

Field	OAuth2 Permission
email	user.email
currency.credits	user.currency.credits
currency.coins	user.currency.coins

# Services

# GET /users/

JSON:Api queryable compliant api

Note that this api has more limited rate limits due to the server load it causes

It is recommended to utilize other apis for use cases where it is deemed more efficient and reserve this only for advanced use cases

/users/{id}

#get-usersid

# GET /users/{id}

Returns an User? object in attributes if the User cannot be determined from given UUID then the api will have data as null

Path fields

Field	Type	Notes
id	UUID

# GET /users/profile-link/{username}

Returns an User? object if an user is found by the lookup from username