User
https://api.knod.es/users/:USER_ID
Query or update a specific user, or list all users for a customer.
A user is a person who has granted a customer access to the user's information on one or more social networks. Nearly all functionality in the Knodes API is from a user's perspective.
Before a customer can make any calls on a user's behalf via this API, they will be required to verify the user's consent via the users/connect action, which provides Knodes with the customer's access credentials to the user's data on a particular network. These credentials, combined with the customer's own application credentials with the network in question (provided via customers/connect), allow Knodes to independently verify that the customer has license to access any data requested on the user’s behalf.
The user object itself has relatively little data, it is predominantly a wrapper for network credentials. It is recommended you obtain a canonical email address for a user and provide it to the API, but if it is not present the backend fetch logic will attempt to determine one from the user's network profiles. For ease of development, the user's name will also be denormalized to the user record during fetch.
Requirements
| Acting Customer | Yes |
|---|---|
| Acting User | No |
HTTP Methods
If a method is not listed, it is not supported for this call
| GET | Query user or list of users |
|---|---|
| POST | Update user, providing the updated attributes for the user object. |
Parameters
Parameters optional unless specified
GET parameters:
| Name | Description | Required? |
|---|---|---|
| USER_ID | ID of user if viewing or updating a particular user. | |
| status | If querying list of users, can specify status to limit to user's in the specified status. | |
| num | If querying list of users, can specify the number to return. | |
| page | If querying list of users, specify the page to return (1-based). |
POST parameters:
| Name | Description | Required? |
|---|---|---|
| USER_ID | ID of user to update | Yes |
| User attributes. | NOTE:: currently the only field that may be manually updated is email. All other fields are related to network credentails and should be manipulated via calls to users/connect and users/disconnect. |
Response
If :USER_ID is provided: User object.
Otherwise: Array of user objects.