{ "opencollection": "1.0.0", "info": { "name": "Auth0 Authentication actions users API", "version": "1.0.0" }, "items": [ { "info": { "name": "users", "type": "folder" }, "items": [ { "info": { "name": "List or Search Users", "type": "http" }, "http": { "method": "GET", "url": "{auth0_domain}/users", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page index of the results to return. First page is 0." }, { "name": "per_page", "value": "", "type": "query", "description": "Number of results per page." }, { "name": "include_totals", "value": "", "type": "query", "description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort by. Use field:order where order is 1 for ascending and -1 for descending. e.g. created_at:1" }, { "name": "connection", "value": "", "type": "query", "description": "Connection filter. Only applies when using search_engine=v1. To filter by connection with search_engine=v2|v3, use q=identities.connection:\"connection_name\"" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields." }, { "name": "include_fields", "value": "", "type": "query", "description": "Whether specified fields are to be included (true) or excluded (false)." }, { "name": "q", "value": "", "type": "query", "description": "Query in Lucene query string syntax. Some query types cannot be used on metadata fields, for details see Searchable Fields." }, { "name": "search_engine", "value": "", "type": "query", "description": "The version of the search engine" }, { "name": "primary_order", "value": "", "type": "query", "description": "If true (default), results are returned in a deterministic order. If false, results may be returned in a non-deterministic order, which can enhance performance for complex queries targeting a small number of users. Set to false only when consistent ordering and pagination is not required." } ] }, "docs": "Retrieve details of users. It is possible to:\n\n- Specify a search criteria for users\n- Sort the users to be returned\n- Select the fields to be returned\n- Specify the number of users to retrieve per page and the page index\n \nThe q query parameter can be used to get users that match the specified criteria using query string syntax.\n\nLearn more" }, { "info": { "name": "Create a User", "type": "http" }, "http": { "method": "POST", "url": "{auth0_domain}/users", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new user for a given database or passwordless connection.\n\nNote: connection is required but other parameters such as email and password are dependent upon the type of connection." }, { "info": { "name": "Get a User", "type": "http" }, "http": { "method": "GET", "url": "{auth0_domain}/users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the user to retrieve." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields." }, { "name": "include_fields", "value": "", "type": "query", "description": "Whether specified fields are to be included (true) or excluded (false)." } ] }, "docs": "Retrieve user details. A list of fields to include or exclude may also be specified. For more information, see Retrieve Users with the Get Users Endpoint.\n" }, { "info": { "name": "Update a User", "type": "http" }, "http": { "method": "PATCH", "url": "{auth0_domain}/users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the user to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a user.\n\nThese are the attributes that can be updated at the root level:\n\n\n\nSome considerations:\n