home api list

Hexostore API Documentation

account

/api/account/

List methods: get

Detail methods: None

A read-only resource that returns a list containing just the currently logged-in user. Because a call to user returns all the users that the logged in user is allowed to see it can be tedious to find the current user in the list. This resource removes that tedium.

Fields

email:

Cannot change without an email confirmation loop

This field is readonly.

first_name:

Unicode string data. Ex: "Hello World"

This field may be blank

This field will default to: '' (empty string)

id:

The primary key for this resource. The primary key for this resource. Integer data. Ex: 2673

This field is readonly.

is_staff:

Designates whether the user can log into this admin site.

This field is required.

last_name:

Unicode string data. Ex: "Hello World"

This field may be blank

This field will default to: '' (empty string)

profile:

A reference to the resource. Maybe specified by URI or ID. Using a URI is recommended.

This field is readonly.

resource_uri:

The unique URI where the object resides.

This field is readonly.

username:

Set to be the same as email. Left in place for historical reasons.

This field is readonly.

Filtering Options

No filtering supported

Sorting Options

id, username, email, profile

© 2024 by CarrĂ© Technologies Inc.