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

Commit 78bd8e7

Browse files
authored
Merge pull request #39 from algorithmiaio/EMUS-36
EMUS-36 adding doc to reflect user.id to the documentation
2 parents 8e47880 + fa4b9d8 commit 78bd8e7

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

source/includes/_users.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
```json
66
{
7+
"id": "123e4567-e89b-12d3-a456-426655440000",
78
"company_name": "Algorithmia",
89
"company_role": "Example User",
910
"email": "[email protected]",
@@ -16,13 +17,14 @@
1617

1718
|Attribute|Type|Description|
1819
|-|-|-|
20+
|`id`|String|The unique identifier for this user.|
1921
|`company_name`|String|The name of the user's employer.|
2022
|`company_role`|String|The user's occupation.|
2123
|`email`|String|The user's email address.|
2224
|`fullname`|String|The user's full name.|
2325
|`resource_type`|String|Always set to `user` for users.
2426
|`self_link`|String|The URL that can be used to retrieve this specific user via the REST API.|
25-
|`username`|String|The unique identifier for this user.|
27+
|`username`|String|The unique alias for this user.|
2628

2729
## Create a user
2830

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

6567
```json
6668
{
69+
"id": "123e4567-e89b-12d3-a456-426655440000",
6770
"company_name": "Algorithmia",
6871
"company_role": "Example User",
6972
"email": "[email protected]",
@@ -107,6 +110,7 @@ In order to interact with this endpoint you must provide an admin API key. Visit
107110
"marker": null,
108111
"next_link": null,
109112
"results": [{
113+
"id": "123e4567-e89b-12d3-a456-426655440000",
110114
"company_name": "Algorithmia",
111115
"company_role": "Example User",
112116
"email": "[email protected]",
@@ -199,6 +203,7 @@ In order to interact with this endpoint you must provide an admin API key. Visit
199203

200204
```json
201205
{
206+
"id": "123e4567-e89b-12d3-a456-426655440000",
202207
"company_name": "Algorithmia",
203208
"company_role": "Example User",
204209
"email": "[email protected]",

0 commit comments

Comments
 (0)