3.1 Working With Users Via API
URI: https://myIsoraURL/api/users
Verb | Address | Notes | Additional Details |
GET | /users /users?page=X &page_size=Y | Retrieves a paginated list of all users, Y at a time, along with their basic attributes. By default 25 responses are returned on each page. | The beginning of each response includes a count and a link to the next page. Each entry in the list has a link to itself, which can be used to retrieve that individual user. |
GET | /users/<id> | Retrieves an individual user, or “Not found.” | |
POST | /users | Creates a new user. Returns the newly created user. | body: { “first_name”: string, “last_name”: string, “email” : string, “username”: string, “is_superuser”: Boolean (true/false), “password”: string* } *optional if user exists in LDAP or AD |
PUT | /users/<id> | Updates (replaces) existing user. Returns the user. | Include the username along with any fields which you want to change. |
DELETE | /users/<id> | Removes the user. No content is returned. | |
GET | /users?search=string &page_size=Y | Returns any user objects matching the string. | Useful when testing the API. |