Skip to content
This repository was archived by the owner on Dec 16, 2021. It is now read-only.

EMUS-36 adding doc to reflect user.id to the documentation #39

Merged
merged 2 commits into from
Apr 27, 2020
Merged

EMUS-36 adding doc to reflect user.id to the documentation #39

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34dac16
adding doc to reflect user.id to the documentation
tzhukov-algo Apr 23, 2020
fa4b9d8
cleanup
tzhukov-algo Apr 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion source/includes/_users.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

```json
{
"id": "123e4567-e89b-12d3-a456-426655440000",
"company_name": "Algorithmia",
"company_role": "Example User",
"email": "me@example.com",
Expand All @@ -16,13 +17,14 @@

|Attribute|Type|Description|
|-|-|-|
|`id`|String|The unique identifier for this user.|
|`company_name`|String|The name of the user's employer.|
|`company_role`|String|The user's occupation.|
|`email`|String|The user's email address.|
|`fullname`|String|The user's full name.|
|`resource_type`|String|Always set to `user` for users.
|`self_link`|String|The URL that can be used to retrieve this specific user via the REST API.|
|`username`|String|The unique identifier for this user.|
|`username`|String|The unique alias for this user.|

## Create a user

Expand Down Expand Up @@ -64,6 +66,7 @@ In order to interact with this endpoint you must provide an admin API key. Visit

```json
{
"id": "123e4567-e89b-12d3-a456-426655440000",
"company_name": "Algorithmia",
"company_role": "Example User",
"email": "me@example.com",
Expand Down Expand Up @@ -107,6 +110,7 @@ In order to interact with this endpoint you must provide an admin API key. Visit
"marker": null,
"next_link": null,
"results": [{
"id": "123e4567-e89b-12d3-a456-426655440000",
"company_name": "Algorithmia",
"company_role": "Example User",
"email": "me@example.com",
Expand Down Expand Up @@ -199,6 +203,7 @@ In order to interact with this endpoint you must provide an admin API key. Visit

```json
{
"id": "123e4567-e89b-12d3-a456-426655440000",
"company_name": "Algorithmia",
"company_role": "Example User",
"email": "me@example.com",
Expand Down