{"info":{"_postman_id":"0865c36f-5280-bbb5-0296-77d998fff82b","name":"Auth0 Management API","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"3967924","collectionId":"0865c36f-5280-bbb5-0296-77d998fff82b","publishedId":"RW1YpgPv","public":true,"customColor":null,"publishDate":"2018-04-25T12:19:05.000Z"},"item":[{"name":"Blacklists","item":[{"name":"Get all blacklisted tokens","id":"867c864f-7bdd-8fa0-24fc-e60c37c98dd1","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/blacklists/tokens","description":"

Retrieves the jti and aud of all tokens in the blacklist.

\n","urlObject":{"protocol":"https","path":["api","v2","blacklists","tokens"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"867c864f-7bdd-8fa0-24fc-e60c37c98dd1"},{"name":"Blacklist a token","id":"d9c81927-f517-235c-7b9e-54383cbe1905","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"aud\": \"\",\r\n \"jti\": \"\"\r\n}"},"url":"https://{{auth0_domain}}/api/v2/blacklists/tokens","description":"

Adds the token identified by the jti to a blacklist for the tenant.

Blacklists

\n","_postman_id":"e942a00a-0395-f2ec-6a91-833fe4a8d31f"},{"name":"Client Grants","item":[{"name":"Get all client grants","id":"d781ed41-f11e-49a9-c4d8-b291c246b28d","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/client-grants","urlObject":{"protocol":"https","path":["api","v2","client-grants"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d781ed41-f11e-49a9-c4d8-b291c246b28d"},{"name":"Create a client grant","id":"b1ad0a0c-0cd7-57ef-c752-f8c83d5b784b","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"client_id\": \"\",\r\n \"audience\": \"\",\r\n \"scope\": [\r\n \"\"\r\n ]\r\n}"},"url":"https://{{auth0_domain}}/api/v2/client-grants","urlObject":{"protocol":"https","path":["api","v2","client-grants"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b1ad0a0c-0cd7-57ef-c752-f8c83d5b784b"},{"name":"Delete a client grant","id":"6cb30a17-47ff-4644-bd8f-440fa3d29e67","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/client-grants/:id","urlObject":{"protocol":"https","path":["api","v2","client-grants",":id"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"6cb30a17-47ff-4644-bd8f-440fa3d29e67"},{"name":"Update a client grant","id":"2469c53c-32f8-f014-55ee-c81c22c1f75a","request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"scope\": [\r\n \"\"\r\n ]\r\n}"},"url":"https://{{auth0_domain}}/api/v2/client-grants/:id","urlObject":{"protocol":"https","path":["api","v2","client-grants",":id"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"2469c53c-32f8-f014-55ee-c81c22c1f75a"}],"id":"23b16e77-ef9d-a5c5-ca5f-c29a4847d237","description":"

Client Grants

\n","_postman_id":"23b16e77-ef9d-a5c5-ca5f-c29a4847d237"},{"name":"Clients","item":[{"name":"Get all clients","id":"5e0a510e-14ee-4a13-864d-2e7a78071347","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/clients","description":"

Retrieves a list of all client applications. Accepts a list of fields to include or exclude.
Important: The client_secret and encryption_key attributes can only be retrieved with the read:client_keys scope.

\n","urlObject":{"protocol":"https","path":["api","v2","clients"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5e0a510e-14ee-4a13-864d-2e7a78071347"},{"name":"Create a client","id":"b52991b5-5020-df6a-1af9-1588fd524446","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"\",\r\n \"client_secret\": \"\",\r\n \"logo_uri\": \"\",\r\n \"callbacks\": [\r\n \"\"\r\n ],\r\n \"allowed_origins\": [\r\n \"\"\r\n ],\r\n \"client_aliases\": [\r\n \"\"\r\n ],\r\n \"allowed_clients\": [\r\n \"\"\r\n ],\r\n \"allowed_logout_urls\": [\r\n \"\"\r\n ],\r\n \"token_endpoint_auth_method\": \"\",\r\n \"app_type\": \"\",\r\n \"is_first_party\": true,\r\n \"jwt_configuration\": {\r\n \"lifetime_in_seconds\": 0,\r\n \"secret_encoded\": true,\r\n \"scopes\": {},\r\n \"alg\": \"\"\r\n },\r\n \"encryption_key\": {\r\n \"pub\": \"\",\r\n \"cert\": \"\"\r\n },\r\n \"sso\": true,\r\n \"custom_login_page_on\": true,\r\n \"custom_login_page\": \"\",\r\n \"custom_login_page_preview\": \"\",\r\n \"form_template\": \"\",\r\n \"is_heroku_app\": true,\r\n \"addons\": {\r\n \"aws\": {},\r\n \"azure_blob\": {},\r\n \"azure_sb\": {},\r\n \"rms\": {},\r\n \"mscrm\": {},\r\n \"slack\": {},\r\n \"box\": {},\r\n \"cloudbees\": {},\r\n \"concur\": {},\r\n \"dropbox\": {},\r\n \"echosign\": {},\r\n \"egnyte\": {},\r\n \"firebase\": {},\r\n \"newrelic\": {},\r\n \"office365\": {},\r\n \"salesforce\": {},\r\n \"salesforce_api\": {},\r\n \"salesforce_sandbox_api\": {},\r\n \"samlp\": {},\r\n \"layer\": {},\r\n \"sap_api\": {},\r\n \"sharepoint\": {},\r\n \"springcm\": {},\r\n \"wams\": {},\r\n \"wsfed\": {},\r\n \"zendesk\": {},\r\n \"zoom\": {}\r\n },\r\n \"resource_servers\": [\r\n {\r\n \"identifier\": \"\",\r\n \"scopes\": [\r\n \"\"\r\n ]\r\n }\r\n ],\r\n \"client_metadata\": {},\r\n \"mobile\": {\r\n \"android\": {},\r\n \"ios\": {}\r\n }\r\n}"},"url":"https://{{auth0_domain}}/api/v2/clients","description":"

Creates a new client application. The samples on the right show every attribute that can be used.

Retrieves a client by its id.
Important: The client_secret,encryption_key and signing_keys attributes can only be retrieved with the read:client_keys scope.

Deletes a client and all its related assets (like rules, connections, etc) given its id.

\n","urlObject":{"protocol":"https","path":["api","v2","clients",":id"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"0bc69674-d36f-498d-c8bc-4f8164de8071"},{"name":"Update a client","id":"f6d509c1-6185-a6fb-fbde-5d51b3336cc2","request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"\",\r\n \"client_secret\": \"\",\r\n \"logo_uri\": \"\",\r\n \"callbacks\": [\r\n \"\"\r\n ],\r\n \"allowed_origins\": [\r\n \"\"\r\n ],\r\n \"client_aliases\": [\r\n \"\"\r\n ],\r\n \"allowed_clients\": [\r\n \"\"\r\n ],\r\n \"allowed_logout_urls\": [\r\n \"\"\r\n ],\r\n \"jwt_configuration\": {\r\n \"lifetime_in_seconds\": 0,\r\n \"secret_encoded\": true,\r\n \"scopes\": {},\r\n \"alg\": \"\"\r\n },\r\n \"encryption_key\": {\r\n \"pub\": \"\",\r\n \"cert\": \"\",\r\n \"subject\": \"\"\r\n },\r\n \"sso\": true,\r\n \"custom_login_page_on\": true,\r\n \"token_endpoint_auth_method\": \"\",\r\n \"app_type\": \"\",\r\n \"is_first_party\": true,\r\n \"custom_login_page\": \"\",\r\n \"custom_login_page_preview\": \"\",\r\n \"form_template\": \"\",\r\n \"addons\": {\r\n \"aws\": {},\r\n \"azure_blob\": {},\r\n \"azure_sb\": {},\r\n \"rms\": {},\r\n \"mscrm\": {},\r\n \"slack\": {},\r\n \"box\": {},\r\n \"cloudbees\": {},\r\n \"concur\": {},\r\n \"dropbox\": {},\r\n \"echosign\": {},\r\n \"egnyte\": {},\r\n \"firebase\": {},\r\n \"newrelic\": {},\r\n \"office365\": {},\r\n \"salesforce\": {},\r\n \"salesforce_api\": {},\r\n \"salesforce_sandbox_api\": {},\r\n \"samlp\": {},\r\n \"layer\": {},\r\n \"sap_api\": {},\r\n \"sharepoint\": {},\r\n \"springcm\": {},\r\n \"wams\": {},\r\n \"wsfed\": {},\r\n \"zendesk\": {},\r\n \"zoom\": {}\r\n },\r\n \"resource_servers\": [\r\n {\r\n \"identifier\": \"\",\r\n \"scopes\": [\r\n \"\"\r\n ]\r\n }\r\n ],\r\n \"client_metadata\": {},\r\n \"mobile\": {\r\n \"android\": {},\r\n \"ios\": {}\r\n }\r\n}"},"url":"https://{{auth0_domain}}/api/v2/clients/:id","description":"

Important: The client_secret and encryption_key attributes can only be updated with the update:client_keys scope.

\n","urlObject":{"protocol":"https","path":["api","v2","clients",":id"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"f6d509c1-6185-a6fb-fbde-5d51b3336cc2"}],"id":"0b0249d5-3484-3421-4f3b-8a0bdb3314b1","description":"

Clients

\n","_postman_id":"0b0249d5-3484-3421-4f3b-8a0bdb3314b1"},{"name":"Connections","item":[{"name":"Get all connections","id":"5c8cd6e8-c669-4665-0aff-1483a665af1f","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/connections","description":"

Retrieves every connection matching the specified strategy. All connections are retrieved if no strategy is being specified. Accepts a list of fields to include or exclude in the resulting list of connection objects.

\n","urlObject":{"protocol":"https","path":["api","v2","connections"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5c8cd6e8-c669-4665-0aff-1483a665af1f"},{"name":"Create a connection","id":"c9bb71fd-eaab-73d0-d768-9894756fb901","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"\",\r\n \"strategy\": \"\",\r\n \"options\": {\r\n \"validation\": {},\r\n \"passwordPolicy\": \"\",\r\n \"password_history\": {},\r\n \"password_no_personal_info\": {},\r\n \"password_dictionary\": {}\r\n },\r\n \"enabled_clients\": [\r\n \"\"\r\n ]\r\n}"},"url":"https://{{auth0_domain}}/api/v2/connections","description":"

Creates a new connection according to the JSON object received in body.
The samples on the right show all available attributes. Mandatory attributes are name and strategy.
Valid Strategy names are: ad, adfs, amazon, dropbox, bitbucket, aol, auth0-adldap, auth0-oidc, auth0, baidu, bitly, box, custom, dwolla, email, evernote-sandbox, evernote, exact, facebook, fitbit, flickr, github, google-apps, google-oauth2, google-openid, instagram, ip, linkedin, miicard, oauth1, oauth2, office365, paypal, pingfederate, planningcenter, renren, salesforce-community, salesforce-sandbox, salesforce, samlp, sharepoint, shopify, sms, soundcloud, thecity-sandbox, thecity, thirtysevensignals, twitter, untappd, vkontakte, waad, weibo, windowslive, wordpress, yahoo, yammer, yandex

Retrieves a connection by its id.

Deletes a connection and all its users.

\n","urlObject":{"protocol":"https","path":["api","v2","connections",":id"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"ebc131d0-1944-8d4f-0f8a-855afc9c9406"},{"name":"Update a connection","id":"e13c5f13-4124-d248-7e18-e8e6d6950ce5","request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"options\": {\r\n \"validation\": {},\r\n \"passwordPolicy\": \"\",\r\n \"password_history\": {},\r\n \"password_no_personal_info\": {},\r\n \"password_dictionary\": {}\r\n },\r\n \"enabled_clients\": [\r\n \"\"\r\n ]\r\n}"},"url":"https://{{auth0_domain}}/api/v2/connections/:id","description":"

Note: if you use the options parameter, the whole options object will be overridden, ensure all parameters are present

Deletes a specified connection user by its email (currently only database connections are supported and you cannot delete all users from specific connection).

\n","urlObject":{"protocol":"https","path":["api","v2","connections",":id","users"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"1d7ae4e4-6b72-781f-2f81-75203e1adb57"}],"id":"5cbf0deb-946c-64d0-6e2a-2ec3f9efb846","description":"

Connections

\n","_postman_id":"5cbf0deb-946c-64d0-6e2a-2ec3f9efb846"},{"name":"Device Credentials","item":[{"name":"List device credentials","id":"6ed6cf08-1f9d-2bff-2406-b6c20b3ff0d2","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/device-credentials","description":"

You can use the device-credentials endpoint using Basic authentication with username and password from a database connection
The Authorization header should be Authorization: Basic base64(\"{db_conn_name}{user}:{password}\")

\n","urlObject":{"protocol":"https","path":["api","v2","device-credentials"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6ed6cf08-1f9d-2bff-2406-b6c20b3ff0d2"},{"name":"Create a device public key","id":"fb92341d-18b3-bfa5-f602-51fb319920ce","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"device_name\": \"\",\r\n \"type\": \"\",\r\n \"value\": \"\",\r\n \"device_id\": \"\",\r\n \"client_id\": \"\"\r\n}"},"url":"https://{{auth0_domain}}/api/v2/device-credentials","description":"

\n","urlObject":{"protocol":"https","path":["api","v2","device-credentials"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fb92341d-18b3-bfa5-f602-51fb319920ce"},{"name":"Delete a device credential","id":"0aef81bb-4de4-8ae3-41ff-856e198cd95f","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/device-credentials/:id","description":"

\n","urlObject":{"protocol":"https","path":["api","v2","device-credentials",":id"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"0aef81bb-4de4-8ae3-41ff-856e198cd95f"}],"id":"f53ae26f-5380-2381-0579-d8ed693ce960","description":"

Device Credentials

\n","_postman_id":"f53ae26f-5380-2381-0579-d8ed693ce960"},{"name":"Emails","item":[{"name":"Get the email provider","id":"30e36633-b52e-70eb-dcdd-256177a747fc","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/emails/provider","urlObject":{"protocol":"https","path":["api","v2","emails","provider"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"30e36633-b52e-70eb-dcdd-256177a747fc"},{"name":"Delete the email provider","id":"60547125-824b-0106-5a49-f0d2e0cc66d9","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/emails/provider","description":"

USE WITH CAUTION

\n","urlObject":{"protocol":"https","path":["api","v2","emails","provider"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"60547125-824b-0106-5a49-f0d2e0cc66d9"},{"name":"Configure the email provider","id":"cae0a977-2f29-1a12-f9be-3aff5342aef8","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"\",\r\n \"enabled\": true,\r\n \"default_from_address\": \"\",\r\n \"credentials\": {\r\n \"api_key\": \"\"\r\n },\r\n \"settings\": {}\r\n}"},"url":"https://{{auth0_domain}}/api/v2/emails/provider","urlObject":{"protocol":"https","path":["api","v2","emails","provider"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cae0a977-2f29-1a12-f9be-3aff5342aef8"},{"name":"Update the email provider","id":"9baab236-a583-4b98-aa8a-36c625b5b334","request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"\",\r\n \"enabled\": true,\r\n \"default_from_address\": \"\",\r\n \"credentials\": {\r\n \"api_key\": \"\"\r\n },\r\n \"settings\": {}\r\n}"},"url":"https://{{auth0_domain}}/api/v2/emails/provider","urlObject":{"protocol":"https","path":["api","v2","emails","provider"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9baab236-a583-4b98-aa8a-36c625b5b334"}],"id":"6e4c871a-be5b-c386-2bbc-910d74acca6a","description":"

Emails

\n","_postman_id":"6e4c871a-be5b-c386-2bbc-910d74acca6a"},{"name":"Guardian","item":[{"name":"Get a list of factors and statuses","id":"9b64002e-c0ed-eccc-1f58-cab1e00f22c6","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/guardian/factors","description":"

Retrieves all factors. Useful to check factor enablement and trial status.

\n","urlObject":{"protocol":"https","path":["api","v2","guardian","factors"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9b64002e-c0ed-eccc-1f58-cab1e00f22c6"},{"name":"Get a Guardian enrollment","id":"1ef1c8f9-63b7-3a71-b4c8-40818437ddbb","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/guardian/enrollments/:id","description":"

Retrieves an enrollment. Useful to check its type and related metadata.

\n","urlObject":{"protocol":"https","path":["api","v2","guardian","enrollments",":id"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"1ef1c8f9-63b7-3a71-b4c8-40818437ddbb"},{"name":"Delete a Guardian enrollment","id":"4380b174-3a87-13a7-085f-38989646eedc","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/guardian/enrollments/:id","description":"

Deletes an enrollment. Useful when you want to force re-enroll.

\n","urlObject":{"protocol":"https","path":["api","v2","guardian","enrollments",":id"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"4380b174-3a87-13a7-085f-38989646eedc"},{"name":"Get enrollment and verification templates","id":"dfc20448-3b48-7834-eaa3-bcfe39d121c4","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/guardian/factors/sms/templates","description":"

Retrieve both templates. Useful to check if a different template than default were set.

\n","urlObject":{"protocol":"https","path":["api","v2","guardian","factors","sms","templates"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dfc20448-3b48-7834-eaa3-bcfe39d121c4"},{"name":"Update enrollment and verification SMS templates.","id":"1b32e50c-32fc-0e99-5d63-c81dd23dc84c","request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"enrollment_message\": \"\",\r\n \"verification_message\": \"\"\r\n}"},"url":"https://{{auth0_domain}}/api/v2/guardian/factors/sms/templates","description":"

Useful to send custom messages on sms enrollment and verification

\n","urlObject":{"protocol":"https","path":["api","v2","guardian","factors","sms","templates"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1b32e50c-32fc-0e99-5d63-c81dd23dc84c"},{"name":"Get Guardian factor provider","id":"599757fd-b642-6e71-a18b-73003d04f2ce","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/guardian/factors/:factor_name/providers/:name","description":"

Returns provider configuration

\n","urlObject":{"protocol":"https","path":["api","v2","guardian","factors",":factor_name","providers",":name"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"factor_name"},{"type":"any","key":"name"}]}},"response":[],"_postman_id":"599757fd-b642-6e71-a18b-73003d04f2ce"},{"name":"Update Guardian Factor","id":"49c76108-0a37-875e-82d5-581489f60d31","request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"enabled\": true\r\n}"},"url":"https://{{auth0_domain}}/api/v2/guardian/factors/:name","description":"

Useful to enable / disable factor

\n","urlObject":{"protocol":"https","path":["api","v2","guardian","factors",":name"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"name"}]}},"response":[],"_postman_id":"49c76108-0a37-875e-82d5-581489f60d31"},{"name":"Update Guardian's Twilio SMS factor provider","id":"09e54495-b0df-70b0-a368-f2260252b113","request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"from\": \"\",\r\n \"messaging_service_sid\": \"\",\r\n \"auth_token\": \"\",\r\n \"sid\": \"\"\r\n}"},"url":"https://{{auth0_domain}}/api/v2/guardian/factors/sms/providers/twilio","description":"

Useful to configure SMS provider

\n","urlObject":{"protocol":"https","path":["api","v2","guardian","factors","sms","providers","twilio"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"09e54495-b0df-70b0-a368-f2260252b113"}],"id":"2265da32-8854-8f66-8fe8-274c46b4591e","description":"

Guardian

\n","_postman_id":"2265da32-8854-8f66-8fe8-274c46b4591e"},{"name":"Jobs","item":[{"name":"Get a job","id":"de8edc77-8769-4418-1400-f2012caf94ec","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/jobs/:id","description":"

Retrieves a job. Useful to check its status.

\n","urlObject":{"protocol":"https","path":["api","v2","jobs",":id"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"de8edc77-8769-4418-1400-f2012caf94ec"},{"name":"Get failed job error details","id":"cd7580e3-57c5-b199-cb06-a59d44b068cd","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/jobs/:id/errors","urlObject":{"protocol":"https","path":["api","v2","jobs",":id","errors"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"cd7580e3-57c5-b199-cb06-a59d44b068cd"},{"name":"Import users","id":"e0ae3b00-ea90-baa1-3132-8de95d18a7d9","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/jobs/users-imports","description":"

Imports users to a connection from a file using a long running job. Important: The documentation for the file format is here.

\n","urlObject":{"protocol":"https","path":["api","v2","jobs","users-imports"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e0ae3b00-ea90-baa1-3132-8de95d18a7d9"},{"name":"Send a \"verify email address\" email","id":"d755bc95-9b01-b97d-267f-8ada17aacde9","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"user_id\": \"\"\r\n}"},"url":"https://{{auth0_domain}}/api/v2/jobs/verification-email","description":"

Send an email to the specified user that asks them to click a link to verify their email address.

\n","urlObject":{"protocol":"https","path":["api","v2","jobs","verification-email"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d755bc95-9b01-b97d-267f-8ada17aacde9"}],"id":"a908b76d-1595-642e-9195-98518576624e","description":"

Jobs

\n","_postman_id":"a908b76d-1595-642e-9195-98518576624e"},{"name":"Logs","item":[{"name":"Search log events","id":"3e6ca5d7-2123-dd1a-b84b-938535659d29","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/logs","description":"

Retrieves log entries that match the specified search criteria (or list all entries if no criteria is used).
You can search with a criteria using the q parameter or you can search by a specific log ID (search by checkpoint):

The search by criteria can use the following parameters:

q: Search Criteria using Query String Syntax
page: The page number. Zero based
per_page: The amount of entries per page
sort: The field to use for sorting. Use field:order, where order is 1 for ascending and -1 for descending. For example date:-1
fields: A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields
include_fields: true if the fields specified are to be included in the result, false otherwise. Defaults to true
include_totals: true if a query summary must be included in the result, false otherwise. Default false.

The search by checkpoint use the following parameters:

from: Log Event Id to start retrieving logs. You can limit the amount of logs using the take parameter.
take: The total amount of entries to retrieve when using the from parameter.

Event acronym mapping

s: Success Login
seacft: Success Exchange (Authorization Code for Access Token)
feacft: Failed Exchange (Authorization Code for Access Token)
seccft: Success Exchange (Client Credentials for Access Token)
feccft: Failed Exchange (Client Credentials for Access Token)
f: Failed Login
w: Warnings During Login
du: Deleted User
fu: Failed Login (invalid email/username)
fp: Failed Login (wrong password)
fc: Failed by Connector
fco: Failed by CORS
con: Connector Online
coff: Connector Offline
fcpro: Failed Connector Provisioning
ss: Success Signup
fs: Failed Signup
cs: Code Sent
cls: Code/Link Sent
sv: Success Verification Email
fv: Failed Verification Email
scp: Success Change Password
fcp: Failed Change Password
sce: Success Change Email
fce: Failed Change Email
scu: Success Change Username
fcu: Failed Change Username
scpn: Success Change Phone Number
fcpn: Failed Change Phone Number
svr: Success Verification Email Request
fvr: Failed Verification Email Request
scpr: Success Change Password Request
fcpr: Failed Change Password Request
fn: Failed Sending Notification
sapi: API Operation
fapi: Failed API Operation
limit_wc: Blocked Account
limit_mu: Blocked IP Address
limit_ui: Too Many Calls to /userinfo
api_limit: Rate Limit On API
sdu: Successful User Deletion
fdu: Failed User Deletion
slo: Success Logout
flo: Failed Logout
sd: Success Delegation
fd: Failed Delegation

List of fields that can be used in fields and sort

date: The moment when the event occured.
connection: The connection related to the event.
client_id: The client id related to the event
client_name: The name of the client related to the event.
ip: The IP address from where the request that caused the log entry originated.
user_id: The user id related to the event.
user_name: The user name related to the event.
description: The description of the event.
user_agent: The user agent that is related to the event.
type: The event type. Refer to the event acronym mappings above for a list of possible event types.
details: The details object of the event.
strategy: The connection strategy related to the event.
strategy_type: The connection strategy type related to the event.

","urlObject":{"protocol":"https","path":["api","v2","logs"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3e6ca5d7-2123-dd1a-b84b-938535659d29"},{"name":"Get a log event by id","id":"a46db612-3649-016d-bdb8-15d3999b9289","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/logs/:id","description":"

Retrieves the data related to the log entry identified by id. This returns a single log entry representation as specified in the schema.

\n","urlObject":{"protocol":"https","path":["api","v2","logs",":id"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"a46db612-3649-016d-bdb8-15d3999b9289"}],"id":"e7ebc9dc-838e-0be4-ae6d-ba432898bc6f","description":"

Logs

\n","_postman_id":"e7ebc9dc-838e-0be4-ae6d-ba432898bc6f"},{"name":"Resource Servers","item":[{"name":"Get a resource server by its id","id":"c01cbd88-01dc-028a-12c8-2af1b471a196","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/resource-servers/:id","urlObject":{"protocol":"https","path":["api","v2","resource-servers",":id"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"c01cbd88-01dc-028a-12c8-2af1b471a196"},{"name":"Delete a resource server","id":"9f4b0f96-fe8c-3ebb-6bc8-b978fb998e39","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/resource-servers/:id","urlObject":{"protocol":"https","path":["api","v2","resource-servers",":id"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"9f4b0f96-fe8c-3ebb-6bc8-b978fb998e39"},{"name":"Update a resource server","id":"06261c36-7bf5-f8b0-31e6-7dfe0b84527d","request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"\",\r\n \"scopes\": [\r\n {\r\n \"value\": \"\",\r\n \"description\": \"\"\r\n }\r\n ],\r\n \"signing_alg\": \"\",\r\n \"signing_secret\": \"\",\r\n \"token_lifetime\": 0\r\n}"},"url":"https://{{auth0_domain}}/api/v2/resource-servers/:id","urlObject":{"protocol":"https","path":["api","v2","resource-servers",":id"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"06261c36-7bf5-f8b0-31e6-7dfe0b84527d"},{"name":"Create a resource server","id":"99a50328-8839-6b86-db9d-787fd17dbb44","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"\",\r\n \"identifier\": \"\",\r\n \"scopes\": [\r\n {\r\n \"value\": \"\",\r\n \"description\": \"\"\r\n }\r\n ],\r\n \"signing_alg\": \"\",\r\n \"signing_secret\": \"\",\r\n \"token_lifetime\": 0\r\n}"},"url":"https://{{auth0_domain}}/api/v2/resource-servers","urlObject":{"protocol":"https","path":["api","v2","resource-servers"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"99a50328-8839-6b86-db9d-787fd17dbb44"}],"id":"8c78e0fd-cfd9-b87a-7055-2e6b8256627b","description":"

Resource Servers

\n","_postman_id":"8c78e0fd-cfd9-b87a-7055-2e6b8256627b"},{"name":"Rules","item":[{"name":"Get all rules","id":"6d7cc509-6db4-ddfa-e1d2-31353558bd89","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/rules","description":"

Retrieves a list of all rules. Accepts a list of fields to include or exclude.
The enabled parameter can be specified to get enabled or disabled rules. The rule's stage of executing could be set to the following values login_success, login_failure or pre_authorize

\n","urlObject":{"protocol":"https","path":["api","v2","rules"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6d7cc509-6db4-ddfa-e1d2-31353558bd89"},{"name":"Create a rule","id":"a09a3f7a-52a2-b039-0a1b-29a3839656c8","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"\",\r\n \"script\": \"\",\r\n \"order\": {},\r\n \"enabled\": true,\r\n \"stage\": \"\"\r\n}"},"url":"https://{{auth0_domain}}/api/v2/rules","description":"

Creates a new rule according to the JSON object received in body.
The samples on the right show you every attribute that could be used. Mandatory attributes are name and scriptNote: Changing a rule's stage of execution from the default login_success can change the rule's function signature to have user omitted.

\n","urlObject":{"protocol":"https","path":["api","v2","rules"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a09a3f7a-52a2-b039-0a1b-29a3839656c8"},{"name":"Get a rule","id":"9ec93dcb-3d7f-7f93-0d36-b74731193644","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/rules/:id","description":"

Retrieves a rule by its ID. Accepts a list of fields to include or exclude in the result.

\n","urlObject":{"protocol":"https","path":["api","v2","rules",":id"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"9ec93dcb-3d7f-7f93-0d36-b74731193644"},{"name":"Delete a rule","id":"2cc2439a-bed9-2f2f-518e-1f4edc9634ce","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/rules/:id","urlObject":{"protocol":"https","path":["api","v2","rules",":id"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"2cc2439a-bed9-2f2f-518e-1f4edc9634ce"},{"name":"Update a rule","id":"0a84d918-f4d1-bb87-62a5-7be02cb997fc","request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"script\": \"\",\r\n \"name\": \"\",\r\n \"order\": {},\r\n \"enabled\": true\r\n}"},"url":"https://{{auth0_domain}}/api/v2/rules/:id","urlObject":{"protocol":"https","path":["api","v2","rules",":id"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"0a84d918-f4d1-bb87-62a5-7be02cb997fc"}],"id":"ddbca1d7-d97c-b382-109d-d34ff291dbaa","description":"

Rules

\n","_postman_id":"ddbca1d7-d97c-b382-109d-d34ff291dbaa"},{"name":"Stats","item":[{"name":"Get active users count","id":"a2ace1cd-14fe-2ccd-c479-72ec8e5b13f0","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/stats/active-users","description":"

Gets the active users count (logged in during the last 30 days).

\n","urlObject":{"protocol":"https","path":["api","v2","stats","active-users"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a2ace1cd-14fe-2ccd-c479-72ec8e5b13f0"},{"name":"Get daily stats","id":"3825d9b7-e3c8-fabb-9c83-5d4ec3c5cdcc","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/stats/daily","description":"

Gets the daily stats for a particular period.

\n","urlObject":{"protocol":"https","path":["api","v2","stats","daily"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3825d9b7-e3c8-fabb-9c83-5d4ec3c5cdcc"}],"id":"a204fe36-38e7-bd66-551f-426937ad880d","description":"

Stats

\n","_postman_id":"a204fe36-38e7-bd66-551f-426937ad880d"},{"name":"Tenants","item":[{"name":"Get tenant settings","id":"ade5ba49-f95e-85c0-ee0d-2e1818e9834c","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/tenants/settings","urlObject":{"protocol":"https","path":["api","v2","tenants","settings"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ade5ba49-f95e-85c0-ee0d-2e1818e9834c"},{"name":"Update tenant settings","id":"0803b59b-e6f6-041f-e89a-e052847a59f9","request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"change_password\": {\r\n \"enabled\": true,\r\n \"html\": \"\"\r\n },\r\n \"guardian_mfa_page\": {\r\n \"enabled\": true,\r\n \"html\": \"\"\r\n },\r\n \"error_page\": {\r\n \"html\": \"\",\r\n \"show_log_link\": true,\r\n \"url\": \"\"\r\n },\r\n \"flags\": {\r\n \"change_pwd_flow_v1\": true,\r\n \"enable_client_connections\": true,\r\n \"enable_apis_section\": true,\r\n \"enable_pipeline2\": true\r\n },\r\n \"friendly_name\": \"\",\r\n \"picture_url\": \"\",\r\n \"support_email\": \"\",\r\n \"support_url\": \"\",\r\n \"allowed_logout_urls\": [\r\n \"\"\r\n ],\r\n \"session_lifetime\": 0\r\n}"},"url":"https://{{auth0_domain}}/api/v2/tenants/settings","urlObject":{"protocol":"https","path":["api","v2","tenants","settings"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0803b59b-e6f6-041f-e89a-e052847a59f9"}],"id":"6c6dc544-5d84-2243-da4e-78fe1356755e","description":"

Tenants

\n","_postman_id":"6c6dc544-5d84-2243-da4e-78fe1356755e"},{"name":"Tickets","item":[{"name":"Create an email verification ticket","id":"65624a3d-7ef2-b5df-063d-2bc51ee1ebdb","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"result_url\": \"\",\r\n \"user_id\": \"\"\r\n}"},"url":"https://{{auth0_domain}}/api/v2/tickets/email-verification","urlObject":{"protocol":"https","path":["api","v2","tickets","email-verification"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"65624a3d-7ef2-b5df-063d-2bc51ee1ebdb"},{"name":"Create a password change ticket","id":"80b1fa63-8fa5-7384-1d29-ffc1e350c7b6","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"result_url\": \"\",\r\n \"user_id\": \"\",\r\n \"new_password\": \"\",\r\n \"connection_id\": \"\",\r\n \"email\": \"\",\r\n \"ttl_sec\": 0\r\n}"},"url":"https://{{auth0_domain}}/api/v2/tickets/password-change","urlObject":{"protocol":"https","path":["api","v2","tickets","password-change"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"80b1fa63-8fa5-7384-1d29-ffc1e350c7b6"}],"id":"2bcacabc-2033-1623-a1c6-50d018725596","description":"

Tickets

\n","_postman_id":"2bcacabc-2033-1623-a1c6-50d018725596"},{"name":"User Blocks","item":[{"name":"Get blocks by identifier","id":"91cf03ab-2677-d490-037e-ee82099ace53","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/user-blocks","urlObject":{"protocol":"https","path":["api","v2","user-blocks"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"91cf03ab-2677-d490-037e-ee82099ace53"},{"name":"Unblock by identifier","id":"3212934f-019e-3a37-4979-51b45e652887","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/user-blocks","urlObject":{"protocol":"https","path":["api","v2","user-blocks"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3212934f-019e-3a37-4979-51b45e652887"},{"name":"Get a user's blocks","id":"c4ae5dd4-26a7-52d2-4632-9576fdb671ab","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/user-blocks/:id","urlObject":{"protocol":"https","path":["api","v2","user-blocks",":id"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"c4ae5dd4-26a7-52d2-4632-9576fdb671ab"},{"name":"Unblock a user","id":"db3aab2c-9418-971c-e00a-acc08c97577c","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/user-blocks/:id","urlObject":{"protocol":"https","path":["api","v2","user-blocks",":id"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"db3aab2c-9418-971c-e00a-acc08c97577c"}],"id":"e36a8ee7-536b-c4d1-46f3-f0204d0aa3b2","description":"

User Blocks

\n","_postman_id":"e36a8ee7-536b-c4d1-46f3-f0204d0aa3b2"},{"name":"Users","item":[{"name":"List or search users","id":"565f7561-d0ea-a389-baa6-3b6a8ac145eb","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/users","urlObject":{"protocol":"https","path":["api","v2","users"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"565f7561-d0ea-a389-baa6-3b6a8ac145eb"},{"name":"Create a user","id":"defd964f-092a-2c2c-1fe6-b73dfc9139e4","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"connection\": \"\",\r\n \"email\": \"\",\r\n \"username\": \"\",\r\n \"password\": \"\",\r\n \"phone_number\": \"\",\r\n \"user_metadata\": {},\r\n \"email_verified\": true,\r\n \"app_metadata\": {}\r\n}"},"url":"https://{{auth0_domain}}/api/v2/users","description":"

Creates a new user according to the JSON object received in body.
The samples on the right show you every attribute that could be used. The attribute connection is always mandatory but depending on the type of connection you are using there could be others too. For instance, Auth0 DB Connections require email and password.

\n","urlObject":{"protocol":"https","path":["api","v2","users"],"host":["{{auth0_domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"defd964f-092a-2c2c-1fe6-b73dfc9139e4"},{"name":"Get a user","id":"6b988e28-2f39-2b12-fc06-9e244dc7902c","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/users/:id","urlObject":{"protocol":"https","path":["api","v2","users",":id"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"6b988e28-2f39-2b12-fc06-9e244dc7902c"},{"name":"Delete a user","id":"b810dd14-f87f-c383-babb-8e2f3281a6f8","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/users/:id","urlObject":{"protocol":"https","path":["api","v2","users",":id"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"b810dd14-f87f-c383-babb-8e2f3281a6f8"},{"name":"Update a user","id":"3360f2db-0002-df94-03ce-ccc33b6c9fbe","request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"blocked\": true,\r\n \"email_verified\": true,\r\n \"email\": \"\",\r\n \"verify_email\": true,\r\n \"phone_number\": \"\",\r\n \"phone_verified\": true,\r\n \"verify_phone_number\": true,\r\n \"password\": \"\",\r\n \"verify_password\": true,\r\n \"user_metadata\": {},\r\n \"app_metadata\": {},\r\n \"connection\": \"\",\r\n \"username\": \"\",\r\n \"client_id\": \"\"\r\n}"},"url":"https://{{auth0_domain}}/api/v2/users/:id","description":"

Updates a user with the object's properties received in the request's body (the object should be a JSON object).
These are the attributes that can be updated at the root level:

blocked
email_verified
email
verify_email
password
phone_number
phone_verified
verify_password
user_metadata
app_metadata
username

Some considerations:

The properties of the new object will replace the old ones.
The metadata fields are an exception to this rule (user_metadata and app_metadata). These properties are merged instead of being replaced but be careful, the merge only occurs on the first level.
If you are updating email_verified, phone_verified, username or password you need to specify the connection property too.
If your are updating email or phone_number you need to specify the connection and the client_id properties.

Updating a field (non-metadata property)

To mark the email address of a user as verified, the body to send should be:

{ \"email_verified\": true }

Updating a user metadata root property

Let's asume that our test user has the following user_metadata:

{ \"user_metadata\" : { \"profileCode\": 1479 } }

To add the field addresses the body to send should be:

{ \"user_metadata\" : { \"addresses\": {\"work_address\": \"100 Industrial Way\"} }}

The modified object ends up with the following user_metadata property:

{\n  \"user_metadata\": {\n    \"profileCode\": 1479,\n    \"addresses\": { \"work_address\": \"100 Industrial Way\" }\n  }\n}

Updating an inner user metadata property

Starting from previous user metadata, if we want to add the field \"home_address\": \"742 Evergreen Terrace\" in addresses we should send the whole addresses object (since this object is on the first level, it will be merged in, but it's own properties won't). The body to send should be:

{\n  \"user_metadata\": {\n    \"addresses\": {\n      \"work_address\": \"100 Industrial Way\",\n      \"home_address\": \"742 Evergreen Terrace\"\n    }\n  }\n}

The modified object ends up with the following user_metadata property:

{\n  \"user_metadata\": {\n    \"profileCode\": 1479,\n    \"addresses\": {\n      \"work_address\": \"100 Industrial Way\",\n      \"home_address\": \"742 Evergreen Terrace\"\n    }\n  }\n}

\n","urlObject":{"protocol":"https","path":["api","v2","users",":id"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"3360f2db-0002-df94-03ce-ccc33b6c9fbe"},{"name":"Get user's log events","id":"afd4eed5-7c44-e625-5c13-d7205639d8aa","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/users/:user_id/logs","description":"

Retrieve every log event for a specific user id

Event acronym mapping

s: Success Login
seacft: Success Exchange (Authorization Code for Access Token)
feacft: Failed Exchange (Authorization Code for Access Token)
seccft: Success Exchange (Client Credentials for Access Token)
feccft: Failed Exchange (Client Credentials for Access Token)
f: Failed Login
w: Warnings During Login
du: Deleted User
fu: Failed Login (invalid email/username)
fp: Failed Login (wrong password)
fc: Failed by Connector
fco: Failed by CORS
con: Connector Online
coff: Connector Offline
fcpro: Failed Connector Provisioning
ss: Success Signup
fs: Failed Signup
cs: Code Sent
cls: Code/Link Sent
sv: Success Verification Email
fv: Failed Verification Email
scp: Success Change Password
fcp: Failed Change Password
sce: Success Change Email
fce: Failed Change Email
scu: Success Change Username
fcu: Failed Change Username
scpn: Success Change Phone Number
fcpn: Failed Change Phone Number
svr: Success Verification Email Request
fvr: Failed Verification Email Request
scpr: Success Change Password Request
fcpr: Failed Change Password Request
fn: Failed Sending Notification
sapi: API Operation
fapi: Failed API Operation
limit_wc: Blocked Account
limit_mu: Blocked IP Address
limit_ui: Too Many Calls to /userinfo
api_limit: Rate Limit On API
sdu: Successful User Deletion
fdu: Failed User Deletion
slo: Success Logout
flo: Failed Logout
sd: Success Delegation
fd: Failed Delegation

List of fields that can be used in fields and sort

date: The moment when the event occured.
connection: The connection related to the event.
client_id: The client id related to the event
client_name: The name of the client related to the event.
ip: The IP address from where the request that caused the log entry originated.
user_id: The user id related to the event.
user_name: The user name related to the event.
description: The description of the event.
user_agent: The user agent that is related to the event.
type: The event type. Refer to the event acronym mappings above for a list of possible event types.
details: The details object of the event.
strategy: The connection strategy related to the event.
strategy_type: The connection strategy type related to the event.

","urlObject":{"protocol":"https","path":["api","v2","users",":user_id","logs"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"user_id"}]}},"response":[],"_postman_id":"afd4eed5-7c44-e625-5c13-d7205639d8aa"},{"name":"Get a list of Guardian enrollments","id":"00d84b5a-3339-047d-da37-3721e28770e6","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/users/:id/enrollments","description":"

Retrieves all Guardian enrollments.

\n","urlObject":{"protocol":"https","path":["api","v2","users",":id","enrollments"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"00d84b5a-3339-047d-da37-3721e28770e6"},{"name":"Delete a user's multifactor provider","id":"077654d0-1e4f-9e15-9517-9817d12fa428","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/users/:id/multifactor/:provider","urlObject":{"protocol":"https","path":["api","v2","users",":id","multifactor",":provider"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"},{"type":"any","key":"provider"}]}},"response":[],"_postman_id":"077654d0-1e4f-9e15-9517-9817d12fa428"},{"name":"Unlink a user identity","id":"484fe1aa-72fe-1244-2270-113f353009e0","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/users/:id/identities/:provider/:user_id","description":"

Unlinks an identity from the target user, and it becomes a separated user again.

\n","urlObject":{"protocol":"https","path":["api","v2","users",":id","identities",":provider",":user_id"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"},{"type":"any","key":"provider"},{"type":"any","key":"user_id"}]}},"response":[],"_postman_id":"484fe1aa-72fe-1244-2270-113f353009e0"},{"name":"Removes the current recovery token, generates and returns a new one","id":"1db6cc9f-5468-c1b0-6cc4-7eebff286c73","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{auth0_domain}}/api/v2/users/:id/recovery-code-regeneration","urlObject":{"protocol":"https","path":["api","v2","users",":id","recovery-code-regeneration"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"1db6cc9f-5468-c1b0-6cc4-7eebff286c73"},{"name":"Link a user account","id":"0b6df6b6-72b5-ebe1-7b05-7d099f13ffc4","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{auth0_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"provider\": \"\",\r\n \"connection_id\": \"\",\r\n \"user_id\": \"\",\r\n \"link_with\": \"\"\r\n}"},"url":"https://{{auth0_domain}}/api/v2/users/:id/identities","description":"

Links the account specified in the body (secondary account) to the account specified by the id param of the URL (primary account).
There are two ways of invoking the endpoint:

With the authenticated primary account's JWT in the Authorization header, which has the update:current_user_identities scope:
\n
```
\nPOST /api/v2/users/PRIMARY_ACCOUNT_USER_ID/identities\nAuthorization: \"Bearer PRIMARY_ACCOUNT_JWT\"\n{\n  \"link_with\": \"SECONDARY_ACCOUNT_JWT\"\n}\n
```
In this case only the link_with param is required in the body, containing the JWT obtained upon the secondary account's authentication.

With an API V2 generated token with update:users scope:\n

\nPOST /api/v2/users/PRIMARY_ACCOUNT_USER_ID/identities\nAuthorization: \"Bearer YOUR_API_V2_TOKEN\"\n{\n  \"provider\": \"SECONDARY_ACCOUNT_PROVIDER\",\n  \"connection_id\": \"SECONDARY_ACCOUNT_CONNECTION_ID(OPTIONAL)\",\n  \"user_id\": \"SECONDARY_ACCOUNT_USER_ID\"\n}\n

In this case you need to send provider and user_id in the body. Optionally you can also send the connection_id param which is suitable for identifying a particular database connection for the 'auth0' provider.

On successful linking, the endpoint returns the new array of the primary account identities.","urlObject":{"protocol":"https","path":["api","v2","users",":id","identities"],"host":["{{auth0_domain}}"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"0b6df6b6-72b5-ebe1-7b05-7d099f13ffc4"}],"id":"80e85b68-1cbb-9616-9b12-3c5b53f8d8e8","description":"

Users

\n","_postman_id":"80e85b68-1cbb-9616-9b12-3c5b53f8d8e8"}]}