{
"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
update:current_user_identities scope:\n \n POST /api/v2/users/PRIMARY_ACCOUNT_USER_ID/identities\n Authorization: \"Bearer PRIMARY_ACCOUNT_JWT\"\n "
},
{
"info": {
"name": "Unlink a User Identity",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{auth0_domain}/users/:id/identities/:provider/:user_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the primary user account."
},
{
"name": "provider",
"value": "",
"type": "path",
"description": "Identity provider name of the secondary linked account (e.g. `google-oauth2`)."
},
{
"name": "user_id",
"value": "",
"type": "path",
"description": "ID of the secondary linked account (e.g. `123456789081523216417` part after the `|` in `google-oauth2|123456789081523216417`)."
}
]
},
"docs": "Unlink a specific secondary account from a target user. This action requires the ID of both the target user and the secondary account. \n\nUnlinking the secondary account removes it from the identities array of the target user and creates a new standalone profile for the secondary account. To learn more, review Unlink User Accounts.\n"
},
{
"info": {
"name": "Get User's Log Events",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/users/:id/logs",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user of the logs to retrieve"
},
{
"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. Paging is disabled if parameter not sent."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Field to sort by. Use `fieldname:1` for ascending order and `fieldname:-1` for descending."
},
{
"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)."
}
]
},
"docs": "Retrieve log events for a specific user.\n\nNote: For more information on all possible event types, their respective acronyms and descriptions, see Log Event Type Codes.\n\nFor more information on the list of fields that can be used in `sort`, see Searchable Fields.\n\nAuth0 authentication factors for a user."
},
{
"info": {
"name": "Delete a User's Multi-factor Provider",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{auth0_domain}/users/:id/multifactor/:provider",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to remove a multifactor configuration from."
},
{
"name": "provider",
"value": "",
"type": "path",
"description": "The multi-factor provider. Supported values 'duo' or 'google-authenticator'"
}
]
},
"docs": "Remove a multifactor authentication configuration from a user's account. This forces the user to manually reconfigure the multi-factor provider."
},
{
"info": {
"name": "List User's Organizations",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/users/:id/organizations",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to retrieve the organizations for."
},
{
"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. Defaults to 50."
},
{
"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)."
}
]
},
"docs": "Retrieve list of the specified user's current Organization memberships. User must be specified by user ID. For more information, review Auth0 Organizations.\n"
},
{
"info": {
"name": "Get a User's Permissions",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/users/:id/permissions",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to retrieve the permissions for."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"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)."
}
]
},
"docs": "Retrieve all permissions associated with the user."
},
{
"info": {
"name": "Assign Permissions to a User",
"type": "http"
},
"http": {
"method": "POST",
"url": "{auth0_domain}/users/:id/permissions",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to assign permissions to."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Assign permissions to a user."
},
{
"info": {
"name": "Remove Permissions from a User",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{auth0_domain}/users/:id/permissions",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to remove permissions from."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Remove permissions from a user.\n"
},
{
"info": {
"name": "Generate New Multi-factor Authentication (MFA) Recovery Code",
"type": "http"
},
"http": {
"method": "POST",
"url": "{auth0_domain}/users/:id/recovery-code-regeneration",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to regenerate a multi-factor authentication recovery code for."
}
]
},
"docs": "Remove an existing multi-factor authentication (MFA) recovery code and generate a new one. If a user cannot access the original device or account used for MFA enrollment, they can use a recovery code to authenticate. "
},
{
"info": {
"name": "Revokes Selected Resources from a User",
"type": "http"
},
"http": {
"method": "POST",
"url": "{auth0_domain}/users/:id/revoke-access",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Revokes selected resources related to a user (sessions, refresh tokens, ...)."
},
{
"info": {
"name": "Clear Risk Assessment Assessors for a Specific User",
"type": "http"
},
"http": {
"method": "POST",
"url": "{auth0_domain}/users/:id/risk-assessments/clear",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to clear assessors for."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Clear risk assessment assessors for a specific user"
},
{
"info": {
"name": "Get a User's Roles",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/users/:id/roles",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to list roles for."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"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)."
}
]
},
"docs": "Retrieve detailed list of all user roles currently assigned to a user.\n\nNote: This action retrieves all roles assigned to a user in the context of your whole tenant. To retrieve Organization-specific roles, use the following endpoint: Get user roles assigned to an Organization member.\n"
},
{
"info": {
"name": "Assign Roles to a User",
"type": "http"
},
"http": {
"method": "POST",
"url": "{auth0_domain}/users/:id/roles",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to associate roles with."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Assign one or more existing user roles to a user. For more information, review Role-Based Access Control.\n\nNote: New roles cannot be created through this action. Additionally, this action is used to assign roles to a user in the context of your whole tenant. To assign roles in the context of a specific Organization, use the following endpoint: Note: This action removes a role from a user in the context of your whole tenant. If you want to unassign a role from a user in the context of a specific Organization, use the following endpoint: Delete user roles from an Organization member.\n"
},
{
"info": {
"name": "Get Refresh Tokens for a User",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/users/:user_id/refresh-tokens",
"params": [
{
"name": "user_id",
"value": "",
"type": "path",
"description": "ID of the user to get refresh tokens for"
},
{
"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": "from",
"value": "",
"type": "query",
"description": "An optional cursor from which to start the selection (exclusive)."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
}
]
},
"docs": "Retrieve details for a user's refresh tokens."
},
{
"info": {
"name": "Delete Refresh Tokens for a User",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{auth0_domain}/users/:user_id/refresh-tokens",
"params": [
{
"name": "user_id",
"value": "",
"type": "path",
"description": "ID of the user to get remove refresh tokens for"
}
]
},
"docs": "Delete all refresh tokens for a user."
},
{
"info": {
"name": "Get Sessions for User",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/users/:user_id/sessions",
"params": [
{
"name": "user_id",
"value": "",
"type": "path",
"description": "ID of the user to get sessions for"
},
{
"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": "from",
"value": "",
"type": "query",
"description": "An optional cursor from which to start the selection (exclusive)."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
}
]
},
"docs": "Retrieve details for a user's sessions."
},
{
"info": {
"name": "Delete Sessions for User",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{auth0_domain}/users/:user_id/sessions",
"params": [
{
"name": "user_id",
"value": "",
"type": "path",
"description": "ID of the user to get sessions for"
}
]
},
"docs": "Delete all sessions for a user."
}
]
}
],
"bundled": true
}