-
-
Notifications
You must be signed in to change notification settings - Fork 15
/
users.lookupByEmail.json
52 lines (52 loc) · 6.07 KB
/
users.lookupByEmail.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
{
"group": "users",
"name": "users.lookupByEmail",
"deprecated": false,
"desc": "Find a user with an email address.",
"args": {
"email": {
"required": true,
"example": "spengler@ghostbusters.example.com",
"desc": "An email address belonging to a user in the workspace.",
"type": "string"
}
},
"response": {
"examples": [
"{\n \"ok\": true,\n \"user\": {\n \"id\": \"W012A3CDE\",\n \"team_id\": \"T012AB3C4\",\n \"name\": \"spengler\",\n \"deleted\": false,\n \"color\": \"9f69e7\",\n \"real_name\": \"Egon Spengler\",\n \"tz\": \"America/Los_Angeles\",\n \"tz_label\": \"Pacific Daylight Time\",\n \"tz_offset\": -25200,\n \"profile\": {\n \"avatar_hash\": \"ge3b51ca72de\",\n \"status_text\": \"Print is dead\",\n \"status_emoji\": \":books:\",\n \"real_name\": \"Egon Spengler\",\n \"display_name\": \"spengler\",\n \"real_name_normalized\": \"Egon Spengler\",\n \"display_name_normalized\": \"spengler\",\n \"email\": \"spengler@ghostbusters.example.com\",\n \"image_24\": \"https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg\",\n \"image_32\": \"https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg\",\n \"image_48\": \"https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg\",\n \"image_72\": \"https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg\",\n \"image_192\": \"https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg\",\n \"image_512\": \"https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg\",\n \"team\": \"T012AB3C4\"\n },\n \"is_admin\": true,\n \"is_owner\": false,\n \"is_primary_owner\": false,\n \"is_restricted\": false,\n \"is_ultra_restricted\": false,\n \"is_bot\": false,\n \"updated\": 1502138686,\n \"is_app_user\": false,\n \"has_2fa\": false\n }\n}",
"{\n \"ok\": false,\n \"error\": \"users_not_found\"\n}"
]
},
"errors": {
"enterprise_is_restricted": "The method cannot be called from an Enterprise.",
"users_not_found": "Value passed for user was invalid.",
"access_denied": "Access to a resource specified in the request is denied.",
"account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.",
"deprecated_endpoint": "The endpoint has been deprecated.",
"ekm_access_denied": "Administrators have suspended the ability to post a message.",
"invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.",
"method_deprecated": "The method has been deprecated.",
"missing_scope": "The token used is not granted the specific scope permissions required to complete this request.",
"not_allowed_token_type": "The token type used in this request is not allowed.",
"not_authed": "No authentication token provided.",
"no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.",
"org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.",
"token_expired": "Authentication token has expired.",
"token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.",
"two_factor_setup_required": "Two factor setup is required.",
"accesslimited": "Access to this method is limited on the current network.",
"fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.",
"internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.",
"invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.",
"invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments.",
"invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.",
"invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.",
"invalid_form_data": "The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.",
"invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.",
"missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.",
"ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.",
"request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.",
"service_unavailable": "The service is temporarily unavailable.",
"team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete."
}
}