{ "info": { "_postman_id": "0f70c892-0c89-4631-8455-7f3946b03bc0", "name": "PropelAuth", "description": "# Getting Started\n\nWelcome to PropelAuth's Backend API documentation! PropelAuth’s backend APIs allow you to manage users, organizations, and API keys programmatically.\n\nGet started by heading over to [www.propelauth.com](http://www.propelauth.com) to create an account if you haven't already.\n\n## Authentication\n\nThe backend API requires an Authorization header with your API key set as a bearer token.\n\n``` javascript\n{\n \"Authorization\": \"Bearer {YOUR_API_KEY}\"\n}\n\n ```\n\nYou can find your API key by logging into the PropelAuth dashboard and navigating to the **Backend Integration** page. Select the environment you want to create the API key for (test, staging, prod) and click on **Create New API Key**.\n\nEach of your environments are completely separate, meaning you'll need a different API key for each one.\n\n## Base URL\n\nThe base URL for the backend API is your environment's Auth URL. Head over to the **Frontend Integration** page in your PropelAuth dashboard to find yours.\n\nSimilarly to the API key, you'll need a different Auth URL for each of your environments (test, staging, prod). Your test Auth URL is generated by PropelAuth and will look something like \"[https://1581439057.propelauthtest.com](https://15814390537.propelauthtest.com)\".\n\nHowever, your Auth URL for your staging and prod environments are set by you. If your app's domain is \"[https://acme.com\"](https://acme.com), your Auth URL will be \"[https://auth.acme.com\"](https://auth.acme.com).\n\n## User API Keys\n\nPropelAuth offers the ability for [your users to create their own API keys](https://docs.propelauth.com/features/api-keys). These API keys cannot be used in the Authentication header for this API. However, you can use the **API KEY APIs** to create, edit, delete, and validate these API keys for your own API.\n\n## Questions?\n\nCheck out our docs for more information and feel free to email us at [support@propelauth.com](https://mailto:support@propelauth.com) if you have any questions.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "32287940", "_collection_link": "https://speeding-meteor-790468.postman.co/workspace/PropelAuth~309f3f38-a982-4dc7-9c96-35fc34f83eb2/collection/32287940-0f70c892-0c89-4631-8455-7f3946b03bc0?action=share&source=collection_link&creator=32287940" }, "item": [ { "name": "User APIs", "item": [ { "name": "Create User", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"test@propelauth.com\",\n \"email_confirmed\": false,\n \"send_email_to_confirm_email_address\": false,\n \"password\": \"hxjV6A0zcp\",\n \"ask_user_to_update_password_on_login\": true,\n \"username\": \"ant\",\n \"first_name\": \"Anthony\",\n \"last_name\": \"Edwards\",\n \"properties\": {\n \"favoriteSport\": \"basketball\"\n },\n \"ignore_domain_restrictions\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/user/", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "user", "" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"email\": \"test@propelauth.com\",\n \"email_confirmed\": false,\n \"send_email_to_confirm_email_address\": false,\n \"password\": \"hxjV6A0zcp\",\n \"ask_user_to_update_password_on_login\": true,\n \"username\": \"ant\",\n \"first_name\": \"Anthony\",\n \"last_name\": \"Edwards\",\n \"properties\": {\n \"favoriteSport\": \"basketball\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/backend/v1/user/", "path": [ "api", "backend", "v1", "user", "" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Wed, 10 Apr 2024 17:29:06 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "50" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{\n \"user_id\": \"a04d69d7-9347-48a3-aa01-8e7ce9aeee04\"\n}" } ] }, { "name": "Fetch User By User ID", "request": { "method": "GET", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/user/{{USER_ID}}?include_orgs=true", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "user", "{{USER_ID}}" ], "query": [ { "key": "include_orgs", "value": "true", "description": "Whether to include the user’s orgs in the response" } ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "/api/backend/v1/user/?include_orgs=true", "path": [ "api", "backend", "v1", "user", "" ], "query": [ { "key": "include_orgs", "value": "true", "description": "Whether to include the user’s orgs in the response" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Wed, 10 Apr 2024 17:29:34 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "512" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{\n \"user_id\": \"a04d69d7-9347-48a3-aa01-8e7ce9aeee04\",\n \"email\": \"test@propelauth.com\",\n \"email_confirmed\": false,\n \"has_password\": true,\n \"username\": \"ant\",\n \"first_name\": \"Anthony\",\n \"last_name\": \"Edwards\",\n \"picture_url\": \"https://img.propelauth.com/2a27d237-db8c-4f82-84fb-5824dfaedc87.png\",\n \"properties\": {\n \"favoriteSport\": \"basketball\"\n },\n \"metadata\": null,\n \"locked\": false,\n \"enabled\": true,\n \"mfa_enabled\": false,\n \"can_create_orgs\": false,\n \"created_at\": 1712770147,\n \"last_active_at\": 1712770147,\n \"org_id_to_org_info\": {},\n \"update_password_required\": true\n}" } ] }, { "name": "Fetch User By Email Address", "request": { "method": "GET", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/user/email?email=test@propelauth.com&include_orgs=true", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "user", "email" ], "query": [ { "key": "email", "value": "test@propelauth.com" }, { "key": "include_orgs", "value": "true", "description": "Whether to include the user’s orgs in the response" } ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "/api/backend/v1/user/email?email=test@propelauth.com&include_orgs=true", "path": [ "api", "backend", "v1", "user", "email" ], "query": [ { "key": "email", "value": "test@propelauth.com" }, { "key": "include_orgs", "value": "true", "description": "Whether to include the user’s orgs in the response" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Wed, 10 Apr 2024 17:30:10 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "512" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{\n \"user_id\": \"a04d69d7-9347-48a3-aa01-8e7ce9aeee04\",\n \"email\": \"test@propelauth.com\",\n \"email_confirmed\": false,\n \"has_password\": true,\n \"username\": \"ant\",\n \"first_name\": \"Anthony\",\n \"last_name\": \"Edwards\",\n \"picture_url\": \"https://img.propelauth.com/2a27d237-db8c-4f82-84fb-5824dfaedc87.png\",\n \"properties\": {\n \"favoriteSport\": \"basketball\"\n },\n \"metadata\": null,\n \"locked\": false,\n \"enabled\": true,\n \"mfa_enabled\": false,\n \"can_create_orgs\": false,\n \"created_at\": 1712770147,\n \"last_active_at\": 1712770147,\n \"org_id_to_org_info\": {},\n \"update_password_required\": true\n}" } ] }, { "name": "Fetch User By Username", "request": { "method": "GET", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/user/username?username=ant&include_orgs=true", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "user", "username" ], "query": [ { "key": "username", "value": "ant" }, { "key": "include_orgs", "value": "true", "description": "Whether to include the user’s orgs in the response" } ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "/api/backend/v1/user/username?username=ant&include_orgs=true", "path": [ "api", "backend", "v1", "user", "username" ], "query": [ { "key": "username", "value": "ant" }, { "key": "include_orgs", "value": "true", "description": "Whether to include the user’s orgs in the response" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Wed, 10 Apr 2024 17:30:21 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "512" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{\n \"user_id\": \"a04d69d7-9347-48a3-aa01-8e7ce9aeee04\",\n \"email\": \"test@propelauth.com\",\n \"email_confirmed\": false,\n \"has_password\": true,\n \"username\": \"ant\",\n \"first_name\": \"Anthony\",\n \"last_name\": \"Edwards\",\n \"picture_url\": \"https://img.propelauth.com/2a27d237-db8c-4f82-84fb-5824dfaedc87.png\",\n \"properties\": {\n \"favoriteSport\": \"basketball\"\n },\n \"metadata\": null,\n \"locked\": false,\n \"enabled\": true,\n \"mfa_enabled\": false,\n \"can_create_orgs\": false,\n \"created_at\": 1712770147,\n \"last_active_at\": 1712770147,\n \"org_id_to_org_info\": {},\n \"update_password_required\": true\n}" } ] }, { "name": "Query For Users", "request": { "method": "GET", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/user/query", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "user", "query" ], "query": [ { "key": "page_size", "value": "10", "description": "The number of users to return per page", "disabled": true }, { "key": "page_number", "value": "0", "description": "The page number to return", "disabled": true }, { "key": "order_by", "value": "CREATED_AT_ASC", "description": "One of CREATED_AT_ASC, CREATED_AT_DESC, LAST_ACTIVE_AT_ASC, LAST_ACTIVE_AT_DESC, EMAIL, or USERNAME.", "disabled": true }, { "key": "email_or_username", "value": "test@example.com", "description": "A partial email or username to filter the list by", "disabled": true }, { "key": "include_orgs", "value": "true", "description": "Whether to include the user’s orgs in the response\n", "disabled": true }, { "key": "legacy_user_id", "value": "1234", "disabled": true } ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "/api/backend/v1/user/query", "path": [ "api", "backend", "v1", "user", "query" ], "query": [ { "key": "page_size", "value": "10", "description": "The number of users to return per page", "disabled": true }, { "key": "page_number", "value": "0", "description": "The page number to return", "disabled": true }, { "key": "order_by", "value": "CREATED_AT_ASC", "description": "One of CREATED_AT_ASC, CREATED_AT_DESC, LAST_ACTIVE_AT_ASC, LAST_ACTIVE_AT_DESC, EMAIL, or USERNAME.", "disabled": true }, { "key": "email_or_username", "value": "test@example.com", "description": "A partial email or username to filter the list by", "disabled": true }, { "key": "include_orgs", "value": "true", "description": "Whether to include the user’s orgs in the response\n", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Wed, 10 Apr 2024 17:48:29 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "1653" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{\n \"users\": [\n {\n \"user_id\": \"026cf5b5-34a0-4bb5-918a-6f910d13d835\",\n \"email\": \"paul@propelauth.com\",\n \"email_confirmed\": true,\n \"has_password\": false,\n \"first_name\": \"Paul\",\n \"last_name\": \"Test\",\n \"picture_url\": \"https://lh3.googleusercontent.com/a/ACg8ocJGtIn2flEbMt5gIYl7GTlH6IhOpM75950m60fbBleXX3ZO1g=s96-c\",\n \"properties\": {\n \"tos\": true,\n \"metadata\": {\n \"test\": \"test\"\n }\n },\n \"metadata\": {\n \"test\": \"test\"\n },\n \"locked\": false,\n \"enabled\": true,\n \"mfa_enabled\": false,\n \"can_create_orgs\": false,\n \"created_at\": 1712251498,\n \"last_active_at\": 1712761310,\n \"update_password_required\": false\n },\n {\n \"user_id\": \"4be8134b-7e42-468b-aee1-9ef93d011e30\",\n \"email\": \"paul@propelauth.dev\",\n \"email_confirmed\": true,\n \"has_password\": false,\n \"first_name\": \"Paul\",\n \"last_name\": \"Test\",\n \"picture_url\": \"https://lh3.googleusercontent.com/a/ACg8ocJzJXY3vq34YgVs2QqgyJfqZmZtPpRsQOXiiEUhuAWv=s96-c\",\n \"properties\": {\n \"metadata\": {\n \"test\": \"asdf\"\n },\n \"tos\": true\n },\n \"metadata\": {\n \"test\": \"asdf\"\n },\n \"locked\": false,\n \"enabled\": true,\n \"mfa_enabled\": false,\n \"can_create_orgs\": false,\n \"created_at\": 1709681042,\n \"last_active_at\": 1711980768,\n \"legacy_user_id\": \"google-oauth2|118009659705648350113\",\n \"update_password_required\": false\n },\n {\n \"user_id\": \"a04d69d7-9347-48a3-aa01-8e7ce9aeee04\",\n \"email\": \"test@propelauth.com\",\n \"email_confirmed\": true,\n \"has_password\": true,\n \"username\": \"ant\",\n \"first_name\": \"Anthony\",\n \"last_name\": \"Edwards\",\n \"picture_url\": \"https://img.propelauth.com/2a27d237-db8c-4f82-84fb-5824dfaedc87.png\",\n \"properties\": {\n \"favoriteSport\": \"basketball\"\n },\n \"metadata\": null,\n \"locked\": false,\n \"enabled\": true,\n \"mfa_enabled\": false,\n \"can_create_orgs\": false,\n \"created_at\": 1712770147,\n \"last_active_at\": 1712770147,\n \"update_password_required\": true\n }\n ],\n \"total_users\": 3,\n \"current_page\": 0,\n \"page_size\": 10,\n \"has_more_results\": false\n}" } ] }, { "name": "Update User", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"username\",\n \"first_name\": \"firstName\",\n \"last_name\": \"lastName\",\n \"picture_url\": \"https://example.com/img.png\",\n \"properties\": {\n \"favoriteSport\": \"value\"\n },\n \"update_password_required\": false,\n \"legacy_user_id\": \"abc123\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/user/{{USER_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "user", "{{USER_ID}}" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"username\": \"username\",\n \"first_name\": \"firstName\",\n \"last_name\": \"lastName\",\n \"picture_url\": \"https://example.com/img.png\",\n \"properties\": {\n \"favoriteSport\": \"value\"\n },\n \"update_password_required\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/backend/v1/user/", "path": [ "api", "backend", "v1", "user", "" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Wed, 10 Apr 2024 17:48:59 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "2" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{}" } ] }, { "name": "Update User Email", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"new_email\": \"test@example.com\",\n \"require_email_confirmation\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/user/{{USER_ID}}/email", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "user", "{{USER_ID}}", "email" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"new_email\": \"test@example.com\",\n \"require_email_confirmation\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/backend/v1/user//email", "path": [ "api", "backend", "v1", "user", "", "email" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Wed, 10 Apr 2024 17:49:11 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "2" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{}" } ] }, { "name": "Update User Password", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"moresecurethanthis\",\n \"ask_user_to_update_password_on_login\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/user/{{USER_ID}}/password", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "user", "{{USER_ID}}", "password" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"password\": \"moresecurethanthis\",\n \"ask_user_to_update_password_on_login\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/backend/v1/user//password", "path": [ "api", "backend", "v1", "user", "", "password" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Wed, 10 Apr 2024 17:49:26 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "2" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{}" } ] }, { "name": "Create Magic Link", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"test@example.com\",\n \"redirect_to_url\": \"http://localhost:3000\",\n \"expires_in_hours\": 1,\n \"create_new_user_if_one_doesnt_exist\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/magic_link", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "magic_link" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"email\": \"test@example.com\",\n \"redirect_to_url\": \"http://localhost:3000\",\n \"expires_in_hours\": 1,\n \"create_new_user_if_one_doesnt_exist\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/backend/v1/magic_link", "path": [ "api", "backend", "v1", "magic_link" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Wed, 10 Apr 2024 17:49:54 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "283" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{\n \"url\": \"https://15814390537.propelauthtest.com/verify_login_passwordless?t=eyJ0b2tlbiI6ImM2YzRiNjE5YTM0YjFkZjQ5NjQzODBjZDRlMjA1ZjE0NmY4MzI2MmFmNzRiNzhkYjkyZGU3MjZiNjk1Yjk3Mjc4NWVhNDRiMzAyYzk5MWIwOTQ1MDQ1OTg0MzQyNmVjZiIsInVzZXIiOiJhMDRkNjlkNy05MzQ3LTQ4YTMtYWEwMS04ZTdjZTlhZWVlMDQifQ\"\n}" } ] }, { "name": "Create Access Token", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"user_id\": \"{{USER_ID}}\",\n \"duration_in_minutes\": 1440\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/access_token", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "access_token" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"user_id\": \"\",\n \"duration_in_minutes\": 1440\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/backend/v1/access_token", "path": [ "api", "backend", "v1", "access_token" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Thu, 11 Apr 2024 15:00:01 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "1485" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6IjE4ZDU2M2NhLTU3ZjMtNDA0ZC05NjI5LWQ0YWI5M2E2OWVkNSJ9.eyJzdWIiOiJhMDRkNjlkNy05MzQ3LTQ4YTMtYWEwMS04ZTdjZTlhZWVlMDQiLCJpYXQiOjE3MTI4NDc2MDEsImV4cCI6MTcxMjkzNDAwMSwidXNlcl9pZCI6ImEwNGQ2OWQ3LTkzNDctNDhhMy1hYTAxLThlN2NlOWFlZWUwNCIsImlzcyI6Imh0dHBzOi8vMTU4MTQzOTA1MzcucHJvcGVsYXV0aHRlc3QuY29tIiwiZW1haWwiOiJ0ZXN0QHByb3BlbGF1dGguY29tIiwiZmlyc3RfbmFtZSI6IkFudGhvbnkiLCJsYXN0X25hbWUiOiJFZHdhcmRzIiwidXNlcm5hbWUiOiJ1c2VybmFtZSIsIm9yZ19pZF90b19vcmdfbWVtYmVyX2luZm8iOnsiYmRmYmJmODQtYmNlZS00ZGZlLWJhYTUtMWUyZGMwOTI5OTFkIjp7Im9yZ19pZCI6ImJkZmJiZjg0LWJjZWUtNGRmZS1iYWE1LTFlMmRjMDkyOTkxZCIsIm9yZ19uYW1lIjoiVGltYmVyd29sdmVzIiwidXJsX3NhZmVfb3JnX25hbWUiOiJ0aW1iZXJ3b2x2ZXMiLCJvcmdfbWV0YWRhdGEiOnt9LCJ1c2VyX3JvbGUiOiJBZG1pbiIsImluaGVyaXRlZF91c2VyX3JvbGVzX3BsdXNfY3VycmVudF9yb2xlIjpbIkFkbWluIiwiT3duZXIiLCJNZW1iZXIiXSwidXNlcl9wZXJtaXNzaW9ucyI6WyJwcm9wZWxhdXRoOjpjYW5faW52aXRlIiwicHJvcGVsYXV0aDo6Y2FuX2NoYW5nZV9yb2xlcyIsInByb3BlbGF1dGg6OmNhbl9yZW1vdmVfdXNlcnMiLCJwcm9wZWxhdXRoOjpjYW5fc2V0dXBfc2FtbCIsInByb3BlbGF1dGg6OmNhbl9tYW5hZ2VfYXBpX2tleXMiXX19LCJwcm9wZXJ0aWVzIjp7ImZhdm9yaXRlU3BvcnQiOiJ2YWx1ZSJ9fQ.bHKma4eZ3TpH482epbD7s1_tw5K-bfC91_um6XqVerUT4B6EwF7DcWtNUQEsbcJKa1ORpaIgrjUgG3Y_dXUT1V4Cnws9fRLeseJbMYrReRS2U8bXS6m5BDr5iH1CTIrv5b1hrIm3pocRao93Ja1W9m65sFYQsn_XhBCiAwv92gnY44DX5ibfaedi5i1Jd9SqXq0Nx0eMZBNmYjCBilkfIH7G9Ru5rQcYqCyjQmf7xTHbdmoKBIxoZv1t5u1hKDZOCA5pdcOiRDQyagExQhEPXhYVUJw05qRfE9Kr7OOlOK6OQ0yQlQBlmm7sEj9OvtsLRHbXYPGBx_W1aBaxV33ChA\"\n}" } ] }, { "name": "Migrate User From External Source", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"test@example.com\",\n \"email_confirmed\": true,\n \"existing_user_id\": \"1234\",\n \"existing_password_hash\": \"bcrypt_hash\",\n \"existing_mfa_base32_encoded_secret\": \"base32_encoded_secret\",\n \"update_password_required\": false,\n \"enabled\": true,\n \"username\": \"airbud3\",\n \"first_name\": \"Buddy\",\n \"last_name\": \"Framm\",\n \"picture_url\": \"https://example.com/img.png\",\n \"properties\": {\n \"favoriteSport\": \"basketball\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/migrate_user/", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "migrate_user", "" ], "query": [ { "key": "page_size", "value": "10", "disabled": true }, { "key": "page_number", "value": "1", "disabled": true }, { "key": "order_by", "value": "CREATED_AT_ASC", "disabled": true } ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"email\": \"test@example.com\",\n \"email_confirmed\": true,\n \"existing_user_id\": \"1234\",\n \"update_password_required\": false,\n \"enabled\": true,\n \"username\": \"airbud3\",\n \"first_name\": \"Buddy\",\n \"last_name\": \"Framm\",\n \"properties\": {\n \"favoriteSport\": \"basketball\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/api/backend/v1/migrate_user/", "path": [ "api", "backend", "v1", "migrate_user", "" ], "query": [ { "key": "page_size", "value": "10", "disabled": true }, { "key": "page_number", "value": "1", "disabled": true }, { "key": "order_by", "value": "CREATED_AT_ASC", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Wed, 10 Apr 2024 17:53:39 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "50" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{\n \"user_id\": \"e22451c4-9fb6-486a-bb80-9f403e00b27b\"\n}" } ] }, { "name": "Update Migrated User's Password", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"user_id\": \"{{USER_ID}}\",\n \"password_hash\": \"the_password_hash\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/migrate_user/password", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "migrate_user", "password" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"user_id\": \"{{USER_ID}}\",\n \"password_hash\": \"pbkdf2_sha512$10000$3d1bedb5b3973ad7f9a5b36d07aef521$ohZ+ZinTWu+6jLIZvyyqH7n0ey0WNXArQeeta+8yXoJl0aW9M8q4zbS1vv7TAe4FdzX4/L9Glw0YlkFoPnuD0Q==\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/migrate_user/password", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "migrate_user", "password" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Fri, 21 Mar 2025 18:04:29 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "2" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{}" } ] }, { "name": "Delete User", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/user/{{USER_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "user", "{{USER_ID}}" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "/api/backend/v1/user/", "path": [ "api", "backend", "v1", "user", "" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Wed, 10 Apr 2024 17:54:44 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "2" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{}" } ] }, { "name": "Block User", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/user/{{USER_ID}}/disable", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "user", "{{USER_ID}}", "disable" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "/api/backend/v1/user//disable", "path": [ "api", "backend", "v1", "user", "", "disable" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Wed, 10 Apr 2024 17:55:05 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "2" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{}" } ] }, { "name": "Unblock User", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/user/{{USER_ID}}/enable", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "user", "{{USER_ID}}", "enable" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "/api/backend/v1/user//enable", "path": [ "api", "backend", "v1", "user", "", "enable" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Wed, 10 Apr 2024 17:55:09 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "2" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{}" } ] }, { "name": "Disable User 2FA", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/user/{{USER_ID}}/disable_2fa", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "user", "{{USER_ID}}", "disable_2fa" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "/api/backend/v1/user//disable_2fa", "path": [ "api", "backend", "v1", "user", "", "disable_2fa" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Wed, 10 Apr 2024 17:55:15 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "2" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{}" } ] }, { "name": "Resend Email Confirmation", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"user_id\": \"{{USER_ID}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/resend_email_confirmation", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "resend_email_confirmation" ] } }, "response": [ { "name": "Success Response (204)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"user_id\": \"{{USER_ID}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/resend_email_confirmation", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "resend_email_confirmation" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "plain", "header": [ { "key": "date", "value": "Mon, 10 Jun 2024 19:41:12 GMT" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": null } ] }, { "name": "Force Logout All User Sessions", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/user/{{USER_ID}}/logout_all_sessions", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "user", "{{USER_ID}}", "logout_all_sessions" ] } }, "response": [ { "name": "Success Response (204)", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/user/{{USER_ID}}/logout_all_sessions", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "user", "{{USER_ID}}", "logout_all_sessions" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "plain", "header": [ { "key": "date", "value": "Mon, 17 Jun 2024 18:27:57 GMT" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": null } ] } ] }, { "name": "Organization APIs", "item": [ { "name": "Fetch Org", "request": { "method": "GET", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/{{ORG_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "{{ORG_ID}}" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/{{ORG_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "{{ORG_ID}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Access-Control-Allow-Credentials", "value": "true" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=2592000" }, { "key": "Content-Length", "value": "330" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Cross-Origin-Embedder-Policy", "value": "require-corp" }, { "key": "Cross-Origin-Opener-Policy", "value": "same-origin" }, { "key": "Cross-Origin-Resource-Policy", "value": "same-origin" }, { "key": "Date", "value": "Mon, 10 Jun 2024 19:44:44 GMT" }, { "key": "Permissions-Policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "Referrer-Policy", "value": "no-referrer" }, { "key": "Server", "value": "Caddy" }, { "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "X-Xss-Protection", "value": "1; mode=block" } ], "cookie": [], "body": "{\n \"org_id\": \"582e7c11-6b72-40d8-886d-461e6491fa71\",\n \"name\": \"Acme Inc\",\n \"url_safe_org_slug\": \"51c08c1b-8526-40cd-8679-ddb15cea2984\",\n \"can_setup_saml\": false,\n \"is_saml_configured\": false,\n \"is_saml_in_test_mode\": false,\n \"domain\": \"acme.com\",\n \"domain_autojoin\": true,\n \"domain_restrict\": true,\n \"max_users\": 100,\n \"custom_role_mapping_name\": \"Business Plan\"\n}" } ] }, { "name": "Fetch Orgs", "request": { "method": "GET", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/query", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "query" ], "query": [ { "key": "page_size", "value": "10", "description": "The number of organizations to return per page", "disabled": true }, { "key": "page_number", "value": "0", "description": "The page number to return", "disabled": true }, { "key": "order_by", "value": "CREATED_AT_ASC", "description": "Possible values include CREATED_AT_ASC, CREATED_AT_DESC, NAME", "disabled": true }, { "key": "name", "value": "acme.com", "description": "A name to search for. We'll return any organizations whose name contains this value", "disabled": true }, { "key": "legacy_org_id", "value": "1234", "disabled": true } ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/query", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "query" ], "query": [ { "key": "page_size", "value": "10", "description": "The number of organizations to return per page", "disabled": true }, { "key": "page_number", "value": "0", "description": "The page number to return", "disabled": true }, { "key": "order_by", "value": "CREATED_AT_ASC", "description": "Possible values include CREATED_AT_ASC, CREATED_AT_DESC, NAME", "disabled": true }, { "key": "name", "value": "acme.com", "description": "A name to search for. We'll return any organizations whose name contains this value", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Access-Control-Allow-Credentials", "value": "true" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=2592000" }, { "key": "Content-Length", "value": "220" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Cross-Origin-Embedder-Policy", "value": "require-corp" }, { "key": "Cross-Origin-Opener-Policy", "value": "same-origin" }, { "key": "Cross-Origin-Resource-Policy", "value": "same-origin" }, { "key": "Date", "value": "Mon, 10 Jun 2024 19:46:08 GMT" }, { "key": "Permissions-Policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "Referrer-Policy", "value": "no-referrer" }, { "key": "Server", "value": "Caddy" }, { "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "X-Xss-Protection", "value": "1; mode=block" } ], "cookie": [], "body": "{\n \"orgs\": [\n {\n \"org_id\": \"582e7c11-6b72-40d8-886d-461e6491fa71\",\n \"name\": \"Acme Inc\",\n \"is_saml_configured\": false,\n \"custom_role_mapping_name\": \"Business Plan\"\n }\n ],\n \"total_orgs\": 1,\n \"current_page\": 0,\n \"page_size\": 10,\n \"has_more_results\": false\n}" } ] }, { "name": "Fetch Users in Org", "request": { "method": "GET", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/user/org/{{ORG_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "user", "org", "{{ORG_ID}}" ], "query": [ { "key": "page_size", "value": "10", "description": "The number of users to return per page", "disabled": true }, { "key": "page_number", "value": "0", "description": "The page number to return", "disabled": true }, { "key": "role", "value": "Admin", "description": "Only return users with this role within the organization. This is case sensitive.", "disabled": true }, { "key": "include_orgs", "value": "true", "description": "Whether to include all organizations the user is in in the response", "disabled": true } ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/user/org/{{ORG_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "user", "org", "{{ORG_ID}}" ], "query": [ { "key": "page_size", "value": "10", "description": "The number of users to return per page", "disabled": true }, { "key": "page_number", "value": "0", "description": "The page number to return", "disabled": true }, { "key": "role", "value": "Admin", "description": "Only return users with this role within the organization. This is case sensitive.", "disabled": true }, { "key": "include_orgs", "value": "true", "description": "Whether to include all organizations the user is in in the response", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Wed, 10 Apr 2024 17:58:27 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "622" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{\n \"users\": [\n {\n \"user_id\": \"026cf5b5-34a0-4bb5-918a-6f910d13d835\",\n \"role_in_org\": \"Admin\",\n \"email\": \"paul@propelauth.com\",\n \"email_confirmed\": true,\n \"has_password\": false,\n \"first_name\": \"Paul\",\n \"last_name\": \"Test\",\n \"picture_url\": \"https://lh3.googleusercontent.com/a/ACg8ocJGtIn2flEbMt5gIYl7GTlH6IhOpM75950m60fbBleXX3ZO1g=s96-c\",\n \"properties\": {\n \"metadata\": {\n \"test\": \"test\"\n },\n \"tos\": true\n },\n \"metadata\": {\n \"test\": \"test\"\n },\n \"locked\": false,\n \"enabled\": true,\n \"mfa_enabled\": false,\n \"can_create_orgs\": false,\n \"created_at\": 1712251498,\n \"last_active_at\": 1712761310,\n \"update_password_required\": false\n }\n ],\n \"total_users\": 1,\n \"current_page\": 0,\n \"page_size\": 10,\n \"has_more_results\": false\n}" } ] }, { "name": "Create Org", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Acme Inc\",\n \"domain\": \"acme.com\",\n \"enable_auto_joining_by_domain\": true,\n \"members_must_have_matching_domain\": true,\n \"custom_role_mapping_name\": \"{{ROLE_CONFIGURATION_NAME}}\",\n \"legacy_org_id\": \"1234\",\n \"max_users\": 100\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"Acme Inc\",\n \"domain\": \"acme.com\",\n \"enable_auto_joining_by_domain\": true,\n \"members_must_have_matching_domain\": true,\n \"max_users\": 100\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Wed, 10 Apr 2024 17:58:56 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "67" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{\n \"org_id\": \"ccfc1445-4619-45b0-a71d-44bacd08868c\",\n \"name\": \"Acme Inc\"\n}" } ] }, { "name": "Add User to Org", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"user_id\": \"{{USER_ID}}\",\n \"org_id\": \"{{ORG_ID}}\",\n \"role\": \"Member\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/add_user", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "add_user" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"user_id\": \"{{USER_ID}}\",\n \"org_id\": \"{{ORG_ID}}\",\n \"role\": \"Member\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/add_user", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "add_user" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Thu, 11 Apr 2024 15:01:06 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "2" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{}" } ] }, { "name": "Invite User to Org", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"test@propelauth.com\",\n \"org_id\": \"{{ORG_ID}}\",\n \"role\": \"Member\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/invite_user", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "invite_user" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"email\": \"test@propelauth.com\",\n \"org_id\": \"{{ORG_ID}}\",\n \"role\": \"Member\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/invite_user", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "invite_user" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "plain", "header": [ { "key": "date", "value": "Thu, 11 Apr 2024 15:01:37 GMT" }, { "key": "content-type", "value": "text/plain; charset=utf-8" }, { "key": "content-length", "value": "70" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "Invitation email sent. It may take a few minutes to reach their inbox." } ] }, { "name": "Change Role", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"user_id\": \"{{USER_ID}}\",\n \"org_id\": \"{{ORG_ID}}\",\n \"role\": \"Member\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/change_role", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "change_role" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"user_id\": \"{{USER_ID}}\",\n \"org_id\": \"{{ORG_ID}}\",\n \"role\": \"Member\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/change_role", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "change_role" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Thu, 11 Apr 2024 15:02:02 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "2" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{}" } ] }, { "name": "Remove User From Org", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"user_id\": \"{{USER_ID}}\",\n \"org_id\": \"{{ORG_ID}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/remove_user", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "remove_user" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"user_id\": \"{{USER_ID}}\",\n \"org_id\": \"{{ORG_ID}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/remove_user", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "remove_user" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Thu, 11 Apr 2024 15:03:15 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "2" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{}" } ] }, { "name": "Update Org", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Acme Inc\",\n \"domain\": \"acme.com\",\n \"extra_domains\": [\"propelauth.com\"],\n \"enable_auto_joining_by_domain\": true,\n \"members_must_have_matching_domain\": true,\n \"max_users\": 100,\n \"can_setup_saml\": true,\n \"legacy_org_id\": \"1234\",\n \"require_2fa_by\": \"2024-02-20 12:34:56 UTC\",\n \"metadata\": {\n \"customKey\": \"customValue\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/{{ORG_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "{{ORG_ID}}" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"Acme Inc\",\n \"domain\": \"acme.com\",\n \"enable_auto_joining_by_domain\": true,\n \"members_must_have_matching_domain\": true,\n \"max_users\": 100,\n \"can_setup_saml\": true,\n \"metadata\": {\n \"customKey\": \"customValue\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/{{ORG_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "{{ORG_ID}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "plain", "header": [ { "key": "date", "value": "Wed, 10 Apr 2024 18:08:07 GMT" }, { "key": "content-length", "value": "0" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": null } ] }, { "name": "Delete Org", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/{{ORG_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "{{ORG_ID}}" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/{{ORG_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "{{ORG_ID}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "plain", "header": [ { "key": "date", "value": "Wed, 10 Apr 2024 18:08:14 GMT" }, { "key": "content-length", "value": "0" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": null } ] }, { "name": "Enable SAML for Org", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/{{ORG_ID}}/allow_saml", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "{{ORG_ID}}", "allow_saml" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/{{ORG_ID}}/allow_saml", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "{{ORG_ID}}", "allow_saml" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Wed, 10 Apr 2024 18:08:34 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "2" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{}" } ] }, { "name": "Disable SAML for Org", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/{{ORG_ID}}/disallow_saml", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "{{ORG_ID}}", "disallow_saml" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/{{ORG_ID}}/disallow_saml", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "{{ORG_ID}}", "disallow_saml" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Wed, 10 Apr 2024 18:08:39 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "2" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{}" } ] }, { "name": "Fetch Role Configurations", "request": { "method": "GET", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/custom_role_mappings", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "custom_role_mappings" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/custom_role_mappings", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "custom_role_mappings" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Access-Control-Allow-Credentials", "value": "true" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=2592000" }, { "key": "Content-Length", "value": "158" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Cross-Origin-Embedder-Policy", "value": "require-corp" }, { "key": "Cross-Origin-Opener-Policy", "value": "same-origin" }, { "key": "Cross-Origin-Resource-Policy", "value": "same-origin" }, { "key": "Date", "value": "Mon, 03 Jun 2024 17:24:28 GMT" }, { "key": "Permissions-Policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "Referrer-Policy", "value": "no-referrer" }, { "key": "Server", "value": "Caddy" }, { "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "X-Xss-Protection", "value": "1; mode=block" } ], "cookie": [], "body": "{\n \"custom_role_mappings\": [\n {\n \"custom_role_mapping_name\": \"Business Plan\",\n \"num_orgs_subscribed\": 2\n },\n {\n \"custom_role_mapping_name\": \"Default\",\n \"num_orgs_subscribed\": 1\n }\n ]\n}" } ] }, { "name": "Subscribe Org To Role Configuration", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "Content-Type", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"custom_role_mapping_name\": \"{{ROLE_CONFIGURATION_NAME}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/{{ORG_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "{{ORG_ID}}" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"custom_role_mapping_name\": \"{{ROLE_CONFIGURATION_NAME}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/{{ORG_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "{{ORG_ID}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Access-Control-Allow-Credentials", "value": "true" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=2592000" }, { "key": "Content-Length", "value": "2" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Cross-Origin-Embedder-Policy", "value": "require-corp" }, { "key": "Cross-Origin-Opener-Policy", "value": "same-origin" }, { "key": "Cross-Origin-Resource-Policy", "value": "same-origin" }, { "key": "Date", "value": "Mon, 03 Jun 2024 17:26:14 GMT" }, { "key": "Permissions-Policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "Referrer-Policy", "value": "no-referrer" }, { "key": "Server", "value": "Caddy" }, { "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "X-Xss-Protection", "value": "1; mode=block" } ], "cookie": [], "body": "{}" } ] }, { "name": "Get Pending Org Invites", "request": { "method": "GET", "header": [] }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/pending_org_invites?org_id={{ORG_ID}}&page_size=10&page_number=0", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "pending_org_invites" ], "query": [ { "key": "org_id", "value": "{{ORG_ID}}" }, { "key": "page_size", "value": "10" }, { "key": "page_number", "value": "0" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Mon, 17 Jun 2024 18:21:53 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "343" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{\n \"total_invites\": 1,\n \"current_page\": 0,\n \"page_size\": 10,\n \"has_more_results\": false,\n \"invites\": [\n {\n \"invitee_email\": \"paul@propelauth.com\",\n \"org_id\": \"4896c602-7c67-4d32-a25d-5adb9a15a60e\",\n \"org_name\": \"PropelAuth\",\n \"role_in_org\": \"Owner\",\n \"additional_roles_in_org\": [],\n \"created_at\": 1718648493,\n \"expires_at\": 1719080493,\n \"inviter_email\": null,\n \"inviter_user_id\": null\n }\n ]\n}" } ] }, { "name": "Revoke Pending Org Invite", "request": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "{\n \"invitee_email\": \"test@propelauth.com\",\n \"org_id\": \"{{ORG_ID}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/pending_org_invites", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "pending_org_invites" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "{\n \"invitee_email\": \"paul+example2@propelauth.com\",\n \"org_id\": \"0755954b-21fc-44e1-b684-35acefa6d414\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/pending_org_invites", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "pending_org_invites" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Wed, 14 Aug 2024 15:06:15 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "2" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "content-security-policy", "value": "object-src 'none'; child-src 'none'; frame-src 'none'; worker-src 'none'; frame-ancestors http://localhost:3000; upgrade-insecure-requests; block-all-mixed-content; report-uri https://o1012663.ingest.sentry.io/api/5999441/security/?sentry_key=bb28f260aa2345428f23cd62a1ac1f34" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{}" } ] }, { "name": "Create SAML Connection Link", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"expires_in_seconds\": 86400\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/{{ORG_ID}}/create_saml_connection_link", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "{{ORG_ID}}", "create_saml_connection_link" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"expires_in_seconds\": 86400\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/org/{{ORG_ID}}/create_saml_connection_link", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "org", "{{ORG_ID}}", "create_saml_connection_link" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Fri, 22 Nov 2024 15:41:34 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "153" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{\n \"url\": \"https://example.propelauthtest.com/setup_saml/a4f57bc035bc2c21382f587a40bb45b22361195ebeb1a0d78d48beb58583bc2c7131d88fe4e110\"\n}" } ] }, { "name": "Fetch Org SAML Metadata", "request": { "method": "GET", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/saml_sp_metadata/{{ORG_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "saml_sp_metadata", "{{ORG_ID}}" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/saml_sp_metadata/{{ORG_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "saml_sp_metadata", "{{ORG_ID}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "296" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{\n \"entity_id\": \"https://example.propelauthtest.com/saml/6983/metadata\",\n \"acs_url\": \"https://example.propelauthtest.com/saml/6983/acs\",\n \"logout_url\": \"https://example.propelauthtest.com/saml/6983/logout\"\n}" } ] }, { "name": "Set SAML IdP Metadata", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"idp_entity_id\": \"http://www.okta.com/example\",\n \"idp_sso_url\": \"https://dev.okta.com/app/example/example/sso/saml\",\n \"idp_certificate\": \"-----BEGIN CERTIFICATE-----MIIDqDCCApCgAw-----END CERTIFICATE-----\",\n \"provider\": \"Okta\",\n \"org_id\": \"{{ORG_ID}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/saml_idp_metadata", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "saml_idp_metadata" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"idp_entity_id\": \"http://www.okta.com/example\",\n \"idp_sso_url\": \"https://dev.okta.com/app/example/example/sso/saml\",\n \"idp_certificate\": \"-----BEGIN CERTIFICATE-----MIIDqDCCApCgAw-----END CERTIFICATE-----\",\n \"provider\": \"Okta\",\n \"org_id\": \"{{ORG_ID}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/saml_idp_metadata", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "saml_idp_metadata" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "plain", "header": [ { "key": "date", "value": "Tue, 12 Nov 2024 22:37:53 GMT" }, { "key": "content-length", "value": "0" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": null } ] }, { "name": "Enable SAML Connection", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/saml_idp_metadata/go_live/{{ORG_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "saml_idp_metadata", "go_live", "{{ORG_ID}}" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/saml_idp_metadata/go_live/{{ORG_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "saml_idp_metadata", "go_live", "{{ORG_ID}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "plain", "header": [ { "key": "date", "value": "Tue, 12 Nov 2024 22:28:55 GMT" }, { "key": "content-length", "value": "0" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": null } ] }, { "name": "Delete SAML Connection", "request": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "{\n \"idp_entity_id\": \"\",\n \"idp_sso_url\": \"\",\n \"idp_certificate\": \"\",\n \"provider\": \"\",\n \"org_id\": {{org_id}}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/saml_idp_metadata/{{ORG_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "saml_idp_metadata", "{{ORG_ID}}" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/saml_idp_metadata/{{ORG_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "saml_idp_metadata", "{{ORG_ID}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "plain", "header": [ { "key": "date", "value": "Tue, 12 Nov 2024 22:30:03 GMT" }, { "key": "content-length", "value": "0" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": null } ] } ] }, { "name": "API Key APIs", "item": [ { "name": "Validate API Key", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"api_key_token\": \"{{END_USER_API_KEY}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/end_user_api_keys/validate", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "end_user_api_keys", "validate" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"api_key_token\": \"{{END_USER_API_TOKEN}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/end_user_api_keys/validate", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "end_user_api_keys", "validate" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Thu, 11 Apr 2024 14:52:53 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "1027" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{\n \"metadata\": null,\n \"user\": {\n \"user_id\": \"a04d69d7-9347-48a3-aa01-8e7ce9aeee04\",\n \"email\": \"test@propelauth.com\",\n \"email_confirmed\": true,\n \"has_password\": true,\n \"username\": \"username\",\n \"first_name\": \"Anthony\",\n \"last_name\": \"Edwards\",\n \"picture_url\": \"https://example.com/img.png\",\n \"properties\": {\n \"tos\": true,\n \"favoriteSport\": \"value\"\n },\n \"metadata\": null,\n \"locked\": false,\n \"enabled\": true,\n \"mfa_enabled\": false,\n \"can_create_orgs\": false,\n \"created_at\": 1712770147,\n \"last_active_at\": 1712847115,\n \"org_id_to_org_info\": {\n \"bdfbbf84-bcee-4dfe-baa5-1e2dc092991d\": {\n \"org_id\": \"bdfbbf84-bcee-4dfe-baa5-1e2dc092991d\",\n \"org_name\": \"Timberwolves\",\n \"org_metadata\": {},\n \"url_safe_org_name\": \"timberwolves\",\n \"user_role\": \"Admin\",\n \"inherited_user_roles_plus_current_role\": [\n \"Admin\",\n \"Owner\",\n \"Member\"\n ],\n \"user_permissions\": [\n \"propelauth::can_invite\",\n \"propelauth::can_change_roles\",\n \"propelauth::can_remove_users\",\n \"propelauth::can_setup_saml\",\n \"propelauth::can_manage_api_keys\"\n ]\n }\n },\n \"update_password_required\": false\n },\n \"org\": null,\n \"user_in_org\": null,\n \"user_id\": \"a04d69d7-9347-48a3-aa01-8e7ce9aeee04\",\n \"org_id\": null\n}" } ] }, { "name": "Create API Key", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"user_id\": \"{{USER_ID}}\",\n \"expires_at_seconds\": 1712880246,\n \"metadata\": {\n \"customKey\": \"customValue\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/end_user_api_keys", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "end_user_api_keys" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"org_id\": \"{{ORG_ID}}\",\n \"user_id\": \"{{USER_ID}}\",\n \"expires_at_seconds\": 1630425600,\n \"metadata\": {\n \"customKey\": \"customValue\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/end_user_api_keys", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "end_user_api_keys" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Thu, 11 Apr 2024 14:40:25 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "164" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{\n \"api_key_id\": \"6ba56a96c76f86141435c8211309f4c8\",\n \"api_key_token\": \"6ba56a96c76f86141435c8211309f4c86801439aed6c172d8c1762ee4fd2e576e531d9fffa21ad0b217f6a77013bc1af\"\n}" } ] }, { "name": "Update API Key", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"expires_at_seconds\": 1712848015,\n \"metadata\": {\n \"customKey\": \"customValue\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/end_user_api_keys/{{END_USER_API_KEY_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "end_user_api_keys", "{{END_USER_API_KEY_ID}}" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"expires_at_seconds\": 1712848015,\n \"metadata\": {\n \"customKey\": \"customValue\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/end_user_api_keys/{{END_USER_API_KEY_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "end_user_api_keys", "{{END_USER_API_KEY_ID}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "plain", "header": [ { "key": "date", "value": "Thu, 11 Apr 2024 14:53:42 GMT" }, { "key": "content-length", "value": "0" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": null } ] }, { "name": "Delete API Key", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/end_user_api_keys/{{END_USER_API_KEY_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "end_user_api_keys", "{{END_USER_API_KEY_ID}}" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/end_user_api_keys/{{END_USER_API_KEY_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "end_user_api_keys", "{{END_USER_API_KEY_ID}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "plain", "header": [ { "key": "date", "value": "Thu, 11 Apr 2024 14:55:19 GMT" }, { "key": "content-length", "value": "0" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": null } ] }, { "name": "Fetch API Key", "request": { "method": "GET", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/end_user_api_keys/{{END_USER_API_KEY_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "end_user_api_keys", "{{END_USER_API_KEY_ID}}" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/end_user_api_keys/{{END_USER_API_KEY_ID}}", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "end_user_api_keys", "{{END_USER_API_KEY_ID}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Thu, 11 Apr 2024 14:56:21 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "178" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{\n \"api_key_id\": \"85b90f382257db0ef057982725997fe1\",\n \"created_at\": 1712847088,\n \"expires_at_seconds\": null,\n \"metadata\": null,\n \"user_id\": \"a04d69d7-9347-48a3-aa01-8e7ce9aeee04\",\n \"org_id\": null\n}" } ] }, { "name": "Fetch Active API Keys", "request": { "method": "GET", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/end_user_api_keys", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "end_user_api_keys" ], "query": [ { "key": "user_id", "value": "", "description": "Filter by the user ID of the API key owner.", "disabled": true }, { "key": "user_email", "value": "", "description": "Filter by the email of the API key owner.", "disabled": true }, { "key": "org_id", "value": "", "description": "Filter by the organization ID of the API key owner.", "disabled": true }, { "key": "page_size", "value": "10", "description": "The number of results to return per page.", "disabled": true }, { "key": "page_number", "value": "0", "description": "The page number to return.", "disabled": true } ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/end_user_api_keys", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "end_user_api_keys" ], "query": [ { "key": "user_id", "value": "", "description": "Filter by the user ID of the API key owner.", "disabled": true }, { "key": "user_email", "value": "", "description": "Filter by the email of the API key owner.", "disabled": true }, { "key": "org_id", "value": "", "description": "Filter by the organization ID of the API key owner.", "disabled": true }, { "key": "page_size", "value": "10", "description": "The number of results to return per page.", "disabled": true }, { "key": "page_number", "value": "0", "description": "The page number to return.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Thu, 11 Apr 2024 14:57:43 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "269" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{\n \"api_keys\": [\n {\n \"api_key_id\": \"85b90f382257db0ef057982725997fe1\",\n \"created_at\": 1712847088,\n \"expires_at_seconds\": null,\n \"metadata\": null,\n \"user_id\": \"a04d69d7-9347-48a3-aa01-8e7ce9aeee04\",\n \"org_id\": null\n }\n ],\n \"total_api_keys\": 1,\n \"current_page\": 0,\n \"page_size\": 10,\n \"has_more_results\": false\n}" } ] }, { "name": "Fetch Expired API Keys", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/end_user_api_keys/archived", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "end_user_api_keys", "archived" ], "query": [ { "key": "user_id", "value": "", "description": "Filter by the user ID of the API key owner.", "disabled": true }, { "key": "user_email", "value": "", "description": "Filter by the email of the API key owner.", "disabled": true }, { "key": "org_id", "value": "", "description": "Filter by the organization ID of the API key owner.", "disabled": true }, { "key": "page_size", "value": "10", "description": "The number of results to return per page.", "disabled": true }, { "key": "page_number", "value": "0", "description": "The page number to return.", "disabled": true } ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/end_user_api_keys/archived", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "end_user_api_keys", "archived" ], "query": [ { "key": "user_id", "value": "", "description": "Filter by the user ID of the API key owner.", "disabled": true }, { "key": "user_email", "value": "", "description": "Filter by the email of the API key owner.", "disabled": true }, { "key": "org_id", "value": "", "description": "Filter by the organization ID of the API key owner.", "disabled": true }, { "key": "page_size", "value": "10", "description": "The number of results to return per page.", "disabled": true }, { "key": "page_number", "value": "0", "description": "The page number to return.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Thu, 11 Apr 2024 14:58:50 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "673" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{\n \"api_keys\": [\n {\n \"api_key_id\": \"6ba56a96c76f86141435c8211309f4c8\",\n \"created_at\": 1712846425,\n \"expires_at_seconds\": 1630425600,\n \"metadata\": {\n \"customKey\": \"customValue\"\n },\n \"user_id\": \"a04d69d7-9347-48a3-aa01-8e7ce9aeee04\",\n \"org_id\": \"4896c602-7c67-4d32-a25d-5adb9a15a60e\"\n },\n {\n \"api_key_id\": \"8488868c3e6b31adaf7883c31e78c0d9\",\n \"created_at\": 1712846196,\n \"expires_at_seconds\": 1,\n \"metadata\": null,\n \"user_id\": \"813a8a12-eecc-4629-a36e-16e73d094b54\",\n \"org_id\": null\n },\n {\n \"api_key_id\": \"a7dcac6aba8deb36d50a600698b776a1\",\n \"created_at\": 1705684299,\n \"expires_at_seconds\": 1,\n \"metadata\": {\n \"customKey\": \"customValue\"\n },\n \"user_id\": null,\n \"org_id\": null\n }\n ],\n \"total_api_keys\": 3,\n \"current_page\": 0,\n \"page_size\": 10,\n \"has_more_results\": false\n}" } ] } ] }, { "name": "Social Login APIs", "item": [ { "name": "Fetch User OAuth Tokens", "request": { "method": "GET", "header": [], "url": { "raw": "{{AUTH_URL}}/api/backend/v1/user/{{USER_ID}}/oauth_token", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "user", "{{USER_ID}}", "oauth_token" ] } }, "response": [] } ] }, { "name": "Step-Up MFA APIs", "item": [ { "name": "Verify TOTP Challenge", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"action_type\": \"SENSITIVE_ACTION\",\n \"user_id\": \"{{USER_ID}}\",\n \"code\": \"123456\",\n \"grant_type\": \"TIME_BASED\",\n \"valid_for_seconds\": 60\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/mfa/step-up/verify-totp", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "mfa", "step-up", "verify-totp" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"action_type\": \"SENSITIVE_ACTION\",\n \"user_id\": \"{{USER_ID}}\",\n \"code\": \"411103\",\n \"grant_type\": \"TIME_BASED\",\n \"valid_for_seconds\": 60\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/mfa/step-up/verify-totp", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "mfa", "step-up", "verify-totp" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Fri, 18 Apr 2025 18:05:50 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "116" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{\n \"step_up_grant\": \"765ba468d62c61f30b17098ca6bf9d5e755fbd79caf012c3ffed79a1edf602ad9d63e7f8166b6a4b71c8059ef0da2db4\"\n}" } ] }, { "name": "Verify Step-Up Grant", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"action_type\": \"SENSITIVE_ACTION\",\n \"user_id\": \"{{USER_ID}}\",\n \"grant\": \"765ba468d62...\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/mfa/step-up/verify-grant", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "mfa", "step-up", "verify-grant" ] } }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"action_type\": \"SENSITIVE_ACTION\",\n \"user_id\": \"{{USER_ID}}\",\n \"grant\": \"765ba468d62c61f30b17098ca6bf9d5e755fbd79caf012c3ffed79a1edf602ad9d63e7f8166b6a4b71c8059ef0da2db4\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{AUTH_URL}}/api/backend/v1/mfa/step-up/verify-grant", "host": [ "{{AUTH_URL}}" ], "path": [ "api", "backend", "v1", "mfa", "step-up", "verify-grant" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "date", "value": "Fri, 18 Apr 2025 18:06:23 GMT" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "2" }, { "key": "cross-origin-resource-policy", "value": "same-origin" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "access-control-allow-credentials", "value": "true" }, { "key": "cross-origin-embedder-policy", "value": "require-corp" }, { "key": "strict-transport-security", "value": "max-age=31536000 ; includeSubDomains" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "permissions-policy", "value": "geolocation=(), midi=(), camera=(), usb=(), magnetometer=(), accelerometer=(), vr=(), speaker=(), ambient-light-sensor=(), gyroscope=(), microphone=()" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "cross-origin-opener-policy", "value": "same-origin" } ], "cookie": [], "body": "{}" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{API_KEY}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "API_KEY", "value": "{API_KEY}", "type": "string" }, { "key": "AUTH_URL", "value": "{AUTH_URL}", "type": "string" }, { "key": "USER_ID", "value": "{USER_ID}", "type": "string" }, { "key": "ORG_ID", "value": "{ORG_ID}", "type": "string" }, { "key": "END_USER_API_KEY_ID", "value": "{END_USER_API_KEY_ID}", "type": "string" }, { "key": "END_USER_API_KEY", "value": "{END_USER_API_KEY}", "type": "string" }, { "key": "ROLE_CONFIGURATION_NAME", "value": "{ROLE_CONFIGURATION_NAME}", "type": "string" } ] }