Complete SSO integration collection for Nyimzie platform with secure validation token flow. All user management endpoints follow the pattern: {domain}/api/v1/users/{endpoint}
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"34556976","collectionId":"2134f3d8-7467-4e6d-b64c-e7e60c29f53a","publishedId":"2sB3BGJACV","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-08-14T10:57:25.000Z"},"item":[{"name":"Partner Integration","item":[{"name":"Initiate SSO Session With User ID","event":[{"listen":"test","script":{"id":"d52b0b86-db01-454c-9a0d-1716a9e8cbe8","exec":["if (pm.response.code === 200) {"," const response = pm.response.json();"," if (response.api_status === 'success') {"," pm.collectionVariables.set('validation_token', response.api_data.validation_token);"," console.log('Validation token saved:', response.api_data.validation_token.substring(0, 10) + '...');"," console.log('Frontend URL:', response.api_data.frontend_url);"," }","}"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"f7798a7c-35c1-4d77-8c0e-4011346e3d3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"X-API-Key","value":"","description":"Partner API Key
\n"},{"key":"X-API-Secret","value":"","description":"Partner API Secret
\n"},{"key":"X-Source-App","value":"zoe-academy-smartsapp","description":"Partner application identifier (Zoe Academy International School)
\n"}],"body":{"mode":"raw","raw":"{\n \"user_id\": 202,\n \"user_type\": \"STUDENT\",\n \"expiration_minutes\": 15,\n \"metadata\": {\n \"institution_id\": 1\n }\n}"},"url":"https://sbx.nymzie.com/api/v1/users/sso/sessions/initiate","description":"Create a new SSO session for a user. Endpoint: {domain}/api/v1/users/sso/sessions/initiate
\n","urlObject":{"path":["api","v1","users","sso","sessions","initiate"],"host":["https://sbx.nymzie.com"],"query":[],"variable":[]}},"response":[{"id":"ad412b46-8186-4eb6-ab62-29dcc84f22f1","name":"response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"X-API-Key","value":"","description":"Partner API Key"},{"key":"X-API-Secret","value":"","description":"Partner API Secret"},{"key":"X-Source-App","value":"brainhill-smartsapp","description":"Partner application identifier (BrainHill International School)"}],"body":{"mode":"raw","raw":"{\n \"user_id\": 202,\n \"user_type\": \"STUDENT\",\n \"expiration_minutes\": 15,\n \"metadata\": {\n \"institution_id\": 1\n }\n}"},"url":"https://sbx.nymzie.com/api/v1/users/sso/sessions/initiate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 13 Aug 2025 16:16:07 GMT"},{"key":"X-RateLimit-Limit","value":"200"},{"key":"X-RateLimit-Remaining","value":"198"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"sameorigin"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"api_status\": \"success\",\n \"api_message\": \"SSO session created successfully.\",\n \"api_data\": {\n \"session_key\": \"nSwXePzJH9et4XGKEXMDyrnLt9QoIFG2uE7IzDJkJq3GyqQQCNQQTJ99BhFTX7pn\",\n \"validation_token\": \"NqrSSFDX238e9SmAFgwPsE0KD7KrpBAR\",\n \"expires_at\": \"2025-08-13T16:31:07.000000Z\",\n \"expires_in\": 899,\n \"user\": {\n \"id\": 202,\n \"type\": \"STUDENT\",\n \"first_name\": \"David\",\n \"last_name\": \"Boakye\",\n \"email\": \"qanpontu+3@gmail.com\"\n },\n \"frontend_url\": \"https://nymzie.com?session=NqrSSFDX238e9SmAFgwPsE0KD7KrpBAR\"\n }\n}"}],"_postman_id":"f7798a7c-35c1-4d77-8c0e-4011346e3d3d"},{"name":"SSO Sign-In/Sign-Up - EDUCATOR","event":[{"listen":"test","script":{"id":"d883f0e9-31cd-43cb-ab5d-85a15fc8b7cd","exec":["if (pm.response.code === 200) {"," const response = pm.response.json();"," if (response.api_status === 'success') {"," pm.collectionVariables.set('validation_token', response.api_data.validation_token);"," console.log('✅ Educator created/updated successfully');"," console.log('User ID:', response.api_data.user.id);"," console.log('SSO Unique ID:', response.api_data.user.sso_unique_user_id);"," console.log('Frontend URL:', response.api_data.frontend_url);"," }","}"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"c327c685-d5c4-441c-a7a0-459e468e1ef4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"X-API-Key","value":"","description":"Partner API Key
\n"},{"key":"X-API-Secret","value":"","description":"Partner API Secret
\n"},{"key":"X-Source-App","value":"threadcircle-international","description":"Partner application identifier
\n"}],"body":{"mode":"raw","raw":"{\n \"user_type\": \"EDUCATOR\",\n \"institution_id\": 1,\n \"expiration_minutes\": 15,\n \"educator\": {\n \"sso_unique_user_id\": \"EDU-TEST-001\",\n \"first_name\": \"Sarah\",\n \"middle_name\": \"Jane\",\n \"last_name\": \"Johnson\",\n \"email\": \"sarah.johnson@school.com\",\n \"phone_number\": \"+1234567893\",\n \"gender\": \"FEMALE\",\n \"dob\": \"1985-06-15\",\n \"grades\": [\"GRADE_10\", \"GRADE_11\", \"GRADE_12\"] // GRADE_1, GRADE_2, GRADE_3, GRADE_4, GRADE_5, GRADE_6, \n // GRADE_7, GRADE_8, GRADE_9, GRADE_10, GRADE_11, GRADE_12\n }\n}"},"url":"https://sbx.nymzie.com/api/v1/users/sso/sessions/initiate","description":"Create or update an educator and initiate SSO session. Uses sso_unique_user_id to identify and update existing users.
\n","urlObject":{"path":["api","v1","users","sso","sessions","initiate"],"host":["https://sbx.nymzie.com"],"query":[],"variable":[]}},"response":[{"id":"dbc7456d-f031-4ab0-acd7-4699fcc9f65d","name":"response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"X-API-Key","value":"","description":"Partner API Key"},{"key":"X-API-Secret","value":"","description":"Partner API Secret"},{"key":"X-Source-App","value":"threadcircle-international","description":"Partner application identifier"}],"body":{"mode":"raw","raw":"{\n \"user_type\": \"EDUCATOR\",\n \"institution_id\": 50,\n \"expiration_minutes\": 15,\n \"educator\": {\n \"sso_unique_user_id\": \"EDU-TEST-001\",\n \"first_name\": \"Sarah\",\n \"middle_name\": \"Jane\",\n \"last_name\": \"Johnson\",\n \"email\": \"sarah.johnson@school.com\",\n \"phone_number\": \"+233545655958\",\n \"gender\": \"FEMALE\",\n \"dob\": \"1985-06-15\",\n \"grades\": [\"GRADE_10\", \"GRADE_11\", \"GRADE_12\"] // GRADE_1, GRADE_2, GRADE_3, GRADE_4, GRADE_5, GRADE_6, \n // GRADE_7, GRADE_8, GRADE_9, GRADE_10, GRADE_11, GRADE_12\n }\n}"},"url":"https://sbx.nymzie.com/api/v1/users/sso/sessions/initiate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 22 Oct 2025 18:03:38 GMT"},{"key":"X-RateLimit-Limit","value":"200"},{"key":"X-RateLimit-Remaining","value":"199"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"sameorigin"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"api_status\": \"success\",\n \"api_message\": \"SSO sign-in/sign-up completed successfully. User created/updated and session established.\",\n \"api_data\": {\n \"session_key\": \"sf0ik8G37xQHQLixbtZhXJE7hEkC132kg8HlpNHMcOpWMmC9LIm1jVLEYw7YvbNz\",\n \"validation_token\": \"RiMilW8PvXWvschMWbQK7NQxD7aoagoY\",\n \"expires_at\": \"2025-10-22T18:18:38.000000Z\",\n \"expires_in\": 899,\n \"user\": {\n \"id\": 2038,\n \"type\": \"EDUCATOR\",\n \"sso_unique_user_id\": \"EDU-TEST-001\",\n \"first_name\": \"Sarah\",\n \"last_name\": \"Johnson\",\n \"email\": \"sarah.johnson@school.com\",\n \"username\": \"sarahjohnson5958\"\n },\n \"frontend_url\": \"https://beta.nymzie.com?session=RiMilW8PvXWvschMWbQK7NQxD7aoagoY\"\n }\n}"}],"_postman_id":"c327c685-d5c4-441c-a7a0-459e468e1ef4"},{"name":"SSO Sign-In/Sign-Up - PARENT with Students","event":[{"listen":"test","script":{"id":"6d958367-e901-47b7-87ba-13f20ff8ff8f","exec":["if (pm.response.code === 200) {"," const response = pm.response.json();"," if (response.api_status === 'success') {"," pm.collectionVariables.set('validation_token', response.api_data.validation_token);"," console.log('✅ Parent and students created/updated successfully');"," console.log('Parent User ID:', response.api_data.user.id);"," console.log('Parent SSO Unique ID:', response.api_data.user.sso_unique_user_id);"," console.log('Frontend URL:', response.api_data.frontend_url);"," }","}"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"80844ecc-4346-4c33-9a7c-92fd35dfdbd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"X-API-Key","value":"","description":"Partner API Key
\n"},{"key":"X-API-Secret","value":"","description":"Partner API Secret
\n"},{"key":"X-Source-App","value":"zoe-academy-smartsapp","description":"Partner application identifier
\n"}],"body":{"mode":"raw","raw":"{\n \"user_type\": \"PARENT\",\n \"expiration_minutes\": 15,\n \"parent\": {\n \"sso_unique_user_id\": \"PAR-TEST-001\",\n \"first_name\": \"Michael\",\n \"middle_name\": \"Robert\",\n \"last_name\": \"Smith\",\n \"email\": \"michael.smith@parent.com\",\n \"phone_number\": \"+123456789\",\n \"gender\": \"MALE\",\n \"dob\": \"1978-03-20\"\n },\n \"students\": [\n {\n \"sso_unique_user_id\": \"STU-TEST-001\",\n \"first_name\": \"Emma\",\n \"middle_name\": \"Grace\",\n \"last_name\": \"Smith\",\n \"email\": \"emma.smith@student.com\",\n \"phone_number\": \"+123456789\",\n \"gender\": \"FEMALE\",\n \"dob\": \"2010-08-12\",\n \"grade\": \"GRADE_9\", // GRADE_1, GRADE_2, GRADE_3, GRADE_4, GRADE_5, GRADE_6, GRADE_7, GRADE_8, GRADE_9, GRADE_10, GRADE_11, GRADE_12\n \"institution_id\": 1\n },\n {\n \"sso_unique_user_id\": \"STU-TEST-002\",\n \"first_name\": \"Oliver\",\n \"middle_name\": \"James\",\n \"last_name\": \"Smith\",\n \"email\": \"oliver.smith@student.com\",\n \"gender\": \"MALE\",\n \"dob\": \"2012-05-05\",\n \"grade\": \"GRADE_7\", // GRADE_1, GRADE_2, GRADE_3, GRADE_4, GRADE_5, GRADE_6, GRADE_7, GRADE_8, GRADE_9, GRADE_10, GRADE_11, GRADE_12\n \"institution_id\": 1\n }\n ]\n}"},"url":"https://sbx.nymzie.com/api/v1/users/sso/sessions/initiate","description":"Create or update a parent with multiple students and initiate SSO session. Automatically links parent-child relationships. Parent's institution is set based on first child.
\n","urlObject":{"path":["api","v1","users","sso","sessions","initiate"],"host":["https://sbx.nymzie.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"80844ecc-4346-4c33-9a7c-92fd35dfdbd0"},{"name":"SSO Sign-In/Sign-Up - STUDENT with Parents","event":[{"listen":"test","script":{"id":"f85b1e5b-559f-4bf4-9854-03d96b414a26","exec":["if (pm.response.code === 200) {"," const response = pm.response.json();"," if (response.api_status === 'success') {"," pm.collectionVariables.set('validation_token', response.api_data.validation_token);"," console.log('✅ Student and parents created/updated successfully');"," console.log('Student User ID:', response.api_data.user.id);"," console.log('Student SSO Unique ID:', response.api_data.user.sso_unique_user_id);"," console.log('Frontend URL:', response.api_data.frontend_url);"," }","}"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"0752d0e4-845d-4d44-a0fc-bf0e770547b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"X-API-Key","value":"","description":"Partner API Key
\n"},{"key":"X-API-Secret","value":"","description":"Partner API Secret
\n"},{"key":"X-Source-App","value":"threadcircle-international","description":"Partner application identifier
\n"}],"body":{"mode":"raw","raw":"{\n \"user_type\": \"STUDENT\",\n \"institution_id\": 1,\n \"expiration_minutes\": 15,\n \"student\": {\n \"sso_unique_user_id\": \"STU-TEST-003\",\n \"first_name\": \"Sophia\",\n \"middle_name\": \"Marie\",\n \"last_name\": \"Williams\",\n \"email\": \"sophia.williams@student.com\",\n \"phone_number\": \"+1234567893\",\n \"gender\": \"FEMALE\",\n \"dob\": \"2009-11-22\",\n \"grade\": \"GRADE_11\" // GRADE_1, GRADE_2, GRADE_3, GRADE_4, GRADE_5, GRADE_6, GRADE_7, GRADE_8, GRADE_9, GRADE_10, GRADE_11, GRADE_12\n },\n \"parents\": [\n {\n \"sso_unique_user_id\": \"PAR-TEST-002\",\n \"first_name\": \"Jennifer\",\n \"middle_name\": \"Ann\",\n \"last_name\": \"Williams\",\n \"email\": \"jennifer.williams@parent.com\",\n \"phone_number\": \"+1234567894\",\n \"gender\": \"FEMALE\",\n \"dob\": \"1980-04-10\"\n },\n {\n \"sso_unique_user_id\": \"PAR-TEST-003\",\n \"first_name\": \"David\",\n \"middle_name\": \"Lee\",\n \"last_name\": \"Williams\",\n \"email\": \"david.williams@parent.com\",\n \"phone_number\": \"+1234567895\",\n \"gender\": \"MALE\",\n \"dob\": \"1979-12-18\"\n }\n ]\n}"},"url":"https://sbx.nymzie.com/api/v1/users/sso/sessions/initiate","description":"Create or update a student with multiple parents and initiate SSO session. Automatically links student-parent relationships.
\n","urlObject":{"path":["api","v1","users","sso","sessions","initiate"],"host":["https://sbx.nymzie.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0752d0e4-845d-4d44-a0fc-bf0e770547b5"},{"name":"Validate SSO Session","id":"02a00b4b-4fd5-4db4-b67e-c8b538c2f17b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-API-Key","value":"","description":"Partner API Key
\n"},{"key":"X-API-Secret","value":"","description":"Partner API Secret
\n"},{"key":"X-Source-App","value":"zoe-academy-smartsapp","description":"Partner application identifier (Zoe Academy International School)
\n"}],"url":"https://sbx.nymzie.com/api/v1/users/sso/sessions/validate/","description":"Validate an SSO session and get user authentication data
\n","urlObject":{"path":["api","v1","users","sso","sessions","validate",""],"host":["https://sbx.nymzie.com"],"query":[],"variable":[]}},"response":[{"id":"dac068db-ce49-4677-a8e8-4b3ab82f8d12","name":"response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-API-Key","value":"","description":"Partner API Key"},{"key":"X-API-Secret","value":"","description":"Partner API Secret"},{"key":"X-Source-App","value":"brainhill-smartsapp","description":"Partner application identifier (BrainHill International School)"}],"url":"https://sbx.nymzie.com/api/v1/users/sso/sessions/validate/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 13 Aug 2025 16:16:51 GMT"},{"key":"X-RateLimit-Limit","value":"200"},{"key":"X-RateLimit-Remaining","value":"197"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"sameorigin"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"api_status\": \"success\",\n \"api_message\": \"Your action has been processed.\",\n \"api_data\": {\n \"status\": \"success\",\n \"user\": {\n \"id\": 202,\n \"first_name\": \"David\",\n \"middle_name\": \"Kojo\",\n \"last_name\": \"Boakye\",\n \"email\": \"qanpontu+3@gmail.com\",\n \"address\": \"Spintex\",\n \"phone_number\": \"209366367\",\n \"email_verified_at\": null,\n \"created_at\": \"2025-07-08T17:56:09.000000Z\",\n \"updated_at\": \"2025-08-13T11:28:09.000000Z\",\n \"id_number\": \"GHA-002881817-3\",\n \"type\": \"STUDENT\",\n \"status\": \"APPROVED\",\n \"review_comment\": null,\n \"created_by\": 199,\n \"updated_by\": null,\n \"gender\": \"MALE\",\n \"dob\": \"2015-09-23\",\n \"is_logged_in\": true,\n \"is_enabled\": true,\n \"deleted_at\": null,\n \"profile_picture\": null,\n \"nationality\": \"No National-ID\",\n \"nationality_id_type\": null,\n \"institution\": \"51\",\n \"department\": null,\n \"about_me\": null,\n \"username_type\": \"Email\",\n \"occupation\": null,\n \"username\": \"qanpontu+3@gmail.com\",\n \"syllabus\": \"CAMBRIDGE_INTERNATIONAL\",\n \"grades\": [\n \"GRADE_4\"\n ],\n \"name\": \"David Kojo Boakye\",\n \"user_permissions\": [\n \"view_courses\",\n \"content_mgt\"\n ],\n \"parents\": [],\n \"children\": [],\n \"institutions\": {\n \"id\": 51,\n \"name\": \"Brain Hill International School\"\n },\n \"departments\": null,\n \"permissions\": [],\n \"roles\": [\n {\n \"id\": 1,\n \"name\": \"STUDENT\",\n \"guard_name\": \"api\",\n \"created_at\": \"2023-07-20T06:09:31.000000Z\",\n \"updated_at\": \"2023-07-20T06:09:31.000000Z\",\n \"pivot\": {\n \"model_type\": \"App\\\\Models\\\\User\",\n \"model_id\": 202,\n \"role_id\": 1\n },\n \"permissions\": [\n {\n \"id\": 1,\n \"name\": \"view_courses\",\n \"guard_name\": \"api\",\n \"created_at\": \"2023-07-20T06:11:00.000000Z\",\n \"updated_at\": \"2023-07-20T06:11:00.000000Z\",\n \"pivot\": {\n \"role_id\": 1,\n \"permission_id\": 1\n }\n },\n {\n \"id\": 3,\n \"name\": \"content_mgt\",\n \"guard_name\": \"api\",\n \"created_at\": \"2023-07-20T06:11:14.000000Z\",\n \"updated_at\": \"2023-07-20T06:11:14.000000Z\",\n \"pivot\": {\n \"role_id\": 1,\n \"permission_id\": 3\n }\n }\n ]\n }\n ]\n },\n \"user_institution\": {\n \"id\": 51,\n \"name\": \"Brain Hill International School\"\n },\n \"user_department\": null,\n \"token\": \"790|le9bSI3gSPyhQL2m3ToGti1qsWJyUGKRjzZHnCIE0a5c3798\",\n \"token_expires_at\": \"2025-09-12T16:16:51.073189Z\",\n \"sso_session\": {\n \"id\": 2,\n \"expires_at\": \"2025-08-13T16:31:07.000000Z\",\n \"source_app\": \"brainhill-smartsapp\",\n \"metadata\": {\n \"institution_id\": 1,\n \"security\": {\n \"ip_hash\": \"20473db1cc631e726c0be01b247b8a1f89a502d0cad1f303b264e314034f52d1\",\n \"user_agent_hash\": \"c24f3fa02c1461f825daf4e5bbe06396aa50dd7b3d4d966867bc7e7e77df74b7\",\n \"timestamp\": \"2025-08-13T16:16:07.922463Z\"\n }\n }\n }\n }\n}"},{"id":"a322aaed-fefd-4d74-9b25-b038c959c413","name":"Validate SSO Session","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-API-Key","value":"","description":"Partner API Key"},{"key":"X-API-Secret","value":"","description":"Partner API Secret"},{"key":"X-Source-App","value":"zoe-academy-smartsapp","description":"Partner application identifier (Zoe Academy International School)"}],"url":"https://sbx.nymzie.com/api/v1/users/sso/sessions/validate/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 22 Oct 2025 18:10:06 GMT"},{"key":"X-RateLimit-Limit","value":"200"},{"key":"X-RateLimit-Remaining","value":"198"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"sameorigin"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"api_status\": \"success\",\n \"api_message\": \"Your action has been processed.\",\n \"api_data\": {\n \"status\": \"success\",\n \"user\": {\n \"id\": 2038,\n \"first_name\": \"Sarah\",\n \"middle_name\": \"Jane\",\n \"last_name\": \"Johnson\",\n \"email\": \"sarah.johnson@school.com\",\n \"address\": null,\n \"phone_number\": \"233545655958\",\n \"email_verified_at\": null,\n \"created_at\": \"2025-10-22T18:03:38.000000Z\",\n \"updated_at\": \"2025-10-22T18:10:06.000000Z\",\n \"id_number\": null,\n \"type\": \"EDUCATOR\",\n \"status\": \"APPROVED\",\n \"review_comment\": null,\n \"created_by\": 0,\n \"updated_by\": null,\n \"gender\": \"FEMALE\",\n \"dob\": \"1985-06-15\",\n \"is_logged_in\": true,\n \"is_enabled\": true,\n \"deleted_at\": null,\n \"profile_picture\": null,\n \"nationality\": \"No National-ID\",\n \"nationality_id_type\": null,\n \"about_me\": null,\n \"username_type\": \"Email\",\n \"occupation\": null,\n \"username\": \"sarahjohnson5958\",\n \"grades\": [\n \"GRADE_10\",\n \"GRADE_11\",\n \"GRADE_12\"\n ],\n \"institution_id\": 50,\n \"force_password_change\": true,\n \"password_changed_at\": null,\n \"sso_unique_user_id\": \"EDU-TEST-001\",\n \"name\": \"Sarah Jane Johnson\",\n \"user_permissions\": [\n \"view_courses\",\n \"create_courses\",\n \"content_mgt\",\n \"create_skills\"\n ],\n \"parents\": [],\n \"children\": [],\n \"institution\": {\n \"id\": 50,\n \"name\": \"Thread Circle International School\",\n \"description\": \"Thread Circle International School\",\n \"cover_image\": \"https://sbx.nymzie.com/api/v1/institutions/storage/institutions/Thread-Circle-International-School/cover/Gemini_Generated_Image_og7808og7808og78.png\",\n \"curriculums\": [\n {\n \"id\": 1,\n \"name\": \"Ghana Education Service\",\n \"code\": \"GHANA_EDUCATION_SERVICE\",\n \"description\": \"Ghana Education Service curriculum for basic and secondary education in Ghana\",\n \"pivot\": {\n \"institution_id\": 50,\n \"curriculum_id\": 1,\n \"is_active\": true,\n \"created_at\": \"2025-08-29T18:53:00.000000Z\",\n \"updated_at\": \"2025-08-29T18:53:00.000000Z\"\n }\n },\n {\n \"id\": 2,\n \"name\": \"Cambridge International\",\n \"code\": \"CAMBRIDGE_INTERNATIONAL\",\n \"description\": \"Cambridge International curriculum offering IGCSE, AS, and A Level qualifications\",\n \"pivot\": {\n \"institution_id\": 50,\n \"curriculum_id\": 2,\n \"is_active\": true,\n \"created_at\": \"2025-08-29T18:30:56.000000Z\",\n \"updated_at\": \"2025-08-29T18:30:56.000000Z\"\n }\n }\n ]\n },\n \"permissions\": [],\n \"roles\": [\n {\n \"id\": 2,\n \"name\": \"EDUCATOR\",\n \"guard_name\": \"api\",\n \"created_at\": \"2023-07-20T06:09:45.000000Z\",\n \"updated_at\": \"2023-07-20T06:09:45.000000Z\",\n \"pivot\": {\n \"model_type\": \"App\\\\Models\\\\User\",\n \"model_id\": 2038,\n \"role_id\": 2\n },\n \"permissions\": [\n {\n \"id\": 1,\n \"name\": \"view_courses\",\n \"guard_name\": \"api\",\n \"created_at\": \"2023-07-20T06:11:00.000000Z\",\n \"updated_at\": \"2023-07-20T06:11:00.000000Z\",\n \"pivot\": {\n \"role_id\": 2,\n \"permission_id\": 1\n }\n },\n {\n \"id\": 2,\n \"name\": \"create_courses\",\n \"guard_name\": \"api\",\n \"created_at\": \"2023-07-20T06:11:11.000000Z\",\n \"updated_at\": \"2023-07-20T06:11:11.000000Z\",\n \"pivot\": {\n \"role_id\": 2,\n \"permission_id\": 2\n }\n },\n {\n \"id\": 3,\n \"name\": \"content_mgt\",\n \"guard_name\": \"api\",\n \"created_at\": \"2023-07-20T06:11:14.000000Z\",\n \"updated_at\": \"2023-07-20T06:11:14.000000Z\",\n \"pivot\": {\n \"role_id\": 2,\n \"permission_id\": 3\n }\n },\n {\n \"id\": 4,\n \"name\": \"create_skills\",\n \"guard_name\": \"api\",\n \"created_at\": \"2023-07-20T06:17:32.000000Z\",\n \"updated_at\": \"2023-07-20T06:17:32.000000Z\",\n \"pivot\": {\n \"role_id\": 2,\n \"permission_id\": 4\n }\n }\n ]\n }\n ]\n },\n \"user_institution\": {\n \"id\": 50,\n \"name\": \"Thread Circle International School\",\n \"description\": \"Thread Circle International School\",\n \"cover_image\": \"https://sbx.nymzie.com/api/v1/institutions/storage/institutions/Thread-Circle-International-School/cover/Gemini_Generated_Image_og7808og7808og78.png\",\n \"curriculums\": [\n {\n \"id\": 1,\n \"name\": \"Ghana Education Service\",\n \"code\": \"GHANA_EDUCATION_SERVICE\",\n \"description\": \"Ghana Education Service curriculum for basic and secondary education in Ghana\",\n \"pivot\": {\n \"institution_id\": 50,\n \"curriculum_id\": 1,\n \"is_active\": true,\n \"created_at\": \"2025-08-29T18:53:00.000000Z\",\n \"updated_at\": \"2025-08-29T18:53:00.000000Z\"\n }\n },\n {\n \"id\": 2,\n \"name\": \"Cambridge International\",\n \"code\": \"CAMBRIDGE_INTERNATIONAL\",\n \"description\": \"Cambridge International curriculum offering IGCSE, AS, and A Level qualifications\",\n \"pivot\": {\n \"institution_id\": 50,\n \"curriculum_id\": 2,\n \"is_active\": true,\n \"created_at\": \"2025-08-29T18:30:56.000000Z\",\n \"updated_at\": \"2025-08-29T18:30:56.000000Z\"\n }\n }\n ]\n },\n \"token\": \"1811|U4xeNEhgWEpP94gpwLZnREGJSV9OdGmDAoGbAURua74c0365\",\n \"token_expires_at\": \"2025-11-21T18:10:06.541119Z\",\n \"subscription\": {\n \"has_active\": false,\n \"is_expired\": true,\n \"expires_at\": null,\n \"modules\": [],\n \"package_name\": null,\n \"package_description\": null,\n \"has_assigned_packages\": false,\n \"days_remaining\": 0\n },\n \"sso_session\": {\n \"id\": 3,\n \"expires_at\": \"2025-10-22T18:18:38.000000Z\",\n \"source_app\": \"threadcircle-international\",\n \"metadata\": {\n \"flow\": \"sign-in-sign-up\",\n \"security\": {\n \"ip_hash\": \"5f899b356ab01b9573131438d6be02064d04faaeff841ba90af5dc005725fee5\",\n \"user_agent_hash\": \"964759ebe3a6955a07a2fe7a8de12a8ac67c5192366037ca32f72ca0df906a2c\",\n \"timestamp\": \"2025-10-22T18:03:38.903787Z\"\n }\n }\n }\n }\n}"}],"_postman_id":"02a00b4b-4fd5-4db4-b67e-c8b538c2f17b"},{"name":"List Users for Partner Institution","id":"739c7601-8648-426c-b8e1-7fcc8b25016f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-API-Key","value":"","description":"Partner API Key
\n"},{"key":"X-API-Secret","value":"","description":"Partner API Secret
\n"},{"key":"X-Source-App","value":"zoe-academy-smartsapp","description":"Partner application identifier (Zoe Academy International School)
\n"}],"url":"https://sbx.nymzie.com/api/v1/users/sso/users?filter[type]=STUDENT&filter[status]=approved&page=1&per_page=20","description":"Fetch users from partner's institution for SSO integration
\n","urlObject":{"path":["api","v1","users","sso","users"],"host":["https://sbx.nymzie.com"],"query":[{"description":{"content":"Filter by user type (STUDENT, EDUCATOR, PARENT)
\n","type":"text/plain"},"key":"filter[type]","value":"STUDENT"},{"description":{"content":"Filter by user status
\n","type":"text/plain"},"key":"filter[status]","value":"approved"},{"description":{"content":"Page number for pagination
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Number of users per page
\n","type":"text/plain"},"key":"per_page","value":"20"}],"variable":[]}},"response":[{"id":"121cb2d0-ca17-4bdd-8d96-c75ff79992a3","name":"response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-API-Key","value":"","description":"Partner API Key"},{"key":"X-API-Secret","value":"","description":"Partner API Secret"},{"key":"X-Source-App","value":"brainhill-smartsapp","description":"Partner application identifier (BrainHill International School)"}],"url":{"raw":"https://sbx.nymzie.com/api/v1/users/sso/users?filter[type]=STUDENT&filter[status]=approved&page=1&per_page=20","host":["https://sbx.nymzie.com"],"path":["api","v1","users","sso","users"],"query":[{"key":"filter[type]","value":"STUDENT","description":"Filter by user type (STUDENT, EDUCATOR, PARENT)"},{"key":"filter[status]","value":"approved","description":"Filter by user status"},{"key":"page","value":"1","description":"Page number for pagination"},{"key":"per_page","value":"20","description":"Number of users per page"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 13 Aug 2025 16:17:25 GMT"},{"key":"X-RateLimit-Limit","value":"200"},{"key":"X-RateLimit-Remaining","value":"199"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"sameorigin"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"api_status\": \"success\",\n \"api_message\": \"Your action has been processed.\",\n \"api_data\": {\n \"data\": [\n {\n \"id\": 202,\n \"name\": \"David Kojo Boakye\",\n \"first_name\": \"David\",\n \"last_name\": \"Boakye\",\n \"email\": \"qanpontu+3@gmail.com\",\n \"username\": \"qanpontu+3@gmail.com\",\n \"type\": \"STUDENT\",\n \"status\": \"APPROVED\",\n \"is_enabled\": true,\n \"institution\": {\n \"id\": 51,\n \"name\": \"Brain Hill International School\"\n },\n \"parents\": [],\n \"sso_eligible\": true,\n \"created_at\": \"2025-07-08 17:56:09\"\n },\n {\n \"id\": 194,\n \"name\": \"Francis Unò-Jnr.\",\n \"first_name\": \"Francis\",\n \"last_name\": \"Unò-Jnr.\",\n \"email\": \"junjay.090@gmail.com\",\n \"username\": \"junjay.090@gmail.com\",\n \"type\": \"STUDENT\",\n \"status\": \"APPROVED\",\n \"is_enabled\": true,\n \"institution\": {\n \"id\": 51,\n \"name\": \"Brain Hill International School\"\n },\n \"parents\": [],\n \"sso_eligible\": true,\n \"created_at\": \"2025-05-21 14:38:04\"\n },\n {\n \"id\": 193,\n \"name\": \"Jeannette kani Mears\",\n \"first_name\": \"Jeannette\",\n \"last_name\": \"Mears\",\n \"email\": \"wex.inc20@gmail.com\",\n \"username\": \"wex.inc20@gmail.com\",\n \"type\": \"STUDENT\",\n \"status\": \"APPROVED\",\n \"is_enabled\": true,\n \"institution\": {\n \"id\": 51,\n \"name\": \"Brain Hill International School\"\n },\n \"parents\": [],\n \"sso_eligible\": true,\n \"created_at\": \"2025-05-20 18:10:25\"\n }\n ],\n \"links\": {\n \"first\": \"https://sbx.nymzie.com/api/v1/users/sso/users?page=1\",\n \"last\": \"https://sbx.nymzie.com/api/v1/users/sso/users?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://sbx.nymzie.com/api/v1/users/sso/users?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"https://sbx.nymzie.com/api/v1/users/sso/users\",\n \"per_page\": 20,\n \"to\": 3,\n \"total\": 3\n }\n }\n}"}],"_postman_id":"739c7601-8648-426c-b8e1-7fcc8b25016f"},{"name":"Get Specific User Details","id":"698371d3-d014-4a5e-a8f8-ddd52cf6ac80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-API-Key","value":"","description":"Partner API Key
\n"},{"key":"X-API-Secret","value":"","description":"Partner API Secret
\n"},{"key":"X-Source-App","value":"zoe-academy-smartsapp","description":"Partner application identifier (Zoe Academy International School)
\n"}],"url":"https://sbx.nymzie.com/api/v1/users/sso/users/202","description":"Get detailed information about a specific user from partner's institution
\n","urlObject":{"path":["api","v1","users","sso","users","202"],"host":["https://sbx.nymzie.com"],"query":[],"variable":[]}},"response":[{"id":"875aca2c-2abe-4b08-b551-2cd72b4a4abc","name":"response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-API-Key","value":"","description":"Partner API Key"},{"key":"X-API-Secret","value":"","description":"Partner API Secret"},{"key":"X-Source-App","value":"brainhill-smartsapp","description":"Partner application identifier (BrainHill International School)"}],"url":"https://sbx.nymzie.com/api/v1/users/sso/users/202"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 13 Aug 2025 16:18:02 GMT"},{"key":"X-RateLimit-Limit","value":"200"},{"key":"X-RateLimit-Remaining","value":"198"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"sameorigin"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"api_status\": \"success\",\n \"api_message\": \"User details fetched successfully.\",\n \"api_data\": {\n \"id\": 202,\n \"name\": \"David Kojo Boakye\",\n \"first_name\": \"David\",\n \"last_name\": \"Boakye\",\n \"email\": \"qanpontu+3@gmail.com\",\n \"username\": \"qanpontu+3@gmail.com\",\n \"type\": \"STUDENT\",\n \"status\": \"APPROVED\",\n \"is_enabled\": true,\n \"institution\": {\n \"id\": 51,\n \"name\": \"Brain Hill International School\"\n },\n \"parents\": [],\n \"sso_eligible\": true,\n \"created_at\": \"2025-07-08 17:56:09\"\n }\n}"}],"_postman_id":"698371d3-d014-4a5e-a8f8-ddd52cf6ac80"}],"id":"176c2536-94df-43e1-a77b-84ecc0a72628","description":"Endpoints for third-party partners to integrate SSO with secure validation token flow. All endpoints follow the pattern: {domain}/api/v1/users/sso/{endpoint}. Custom redirects are no longer supported for security.
\n","_postman_id":"176c2536-94df-43e1-a77b-84ecc0a72628"},{"name":"Frontend Integration","item":[{"name":"Frontend SSO with Validation Token","id":"584d88b5-5b92-4ed5-a683-6c23511a22ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sbx.nymzie.com?session=","description":"Test frontend SSO with validation token (secure flow)
\n","urlObject":{"host":["https://sbx.nymzie.com"],"query":[{"description":{"content":"SSO validation token
\n","type":"text/plain"},"key":"session","value":""}],"variable":[]}},"response":[],"_postman_id":"584d88b5-5b92-4ed5-a683-6c23511a22ed"}],"id":"34a90f66-d622-45da-84ff-1e1e6e377195","description":"Testing the complete SSO flow with frontend using secure validation tokens
\n","_postman_id":"34a90f66-d622-45da-84ff-1e1e6e377195"},{"name":"Testing & Examples","item":[{"name":"Full SSO Flow Test","event":[{"listen":"test","script":{"id":"936d2d96-f535-4512-8beb-cf2b5abc6666","exec":["if (pm.response.code === 200) {"," const response = pm.response.json();"," if (response.api_status === 'success') {"," const validationToken = response.api_data.validation_token;"," const frontendUrl = response.api_data.frontend_url;"," "," console.log('=== SSO Session Created ===');"," console.log('Validation Token:', validationToken.substring(0, 10) + '...');"," console.log('Expires At:', response.api_data.expires_at);"," console.log('Expires In:', response.api_data.expires_in + ' seconds');"," console.log('Frontend URL:', frontendUrl);"," console.log('');"," console.log('=== Next Steps ===');"," console.log('1. Copy the frontend URL above');"," console.log('2. Paste it in a browser to test SSO');"," console.log('3. User should be auto-logged in to Nyimzie dashboard');"," "," pm.collectionVariables.set('validation_token', validationToken);"," }","}"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"7c9125ab-e7a5-48b6-8a0c-b1c86b975d1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"X-API-Key","value":"nymzie_rqUsh5Umyj4IFRn5hhcss7cDsIar9VZd"},{"key":"X-API-Secret","value":"Vexn8nbdzooyCQhNw7UgkiAYmXVBf3yNJq3FrNZTg7n3zkQogow8WrACvypehf8t"},{"key":"X-Source-App","value":"zoe-academy-smartsapp"}],"body":{"mode":"raw","raw":"{\n \"user_id\": 23,\n \"user_type\": \"STUDENT\",\n \"expiration_minutes\": 15,\n \"metadata\": {\n \"institution_id\": 1\n }\n}"},"url":"https://sbx.nymzie.com/api/v1/sso/sessions/initiate","description":"Complete flow: Create session → Extract redirect URL → Test redirect
\n","urlObject":{"path":["api","v1","sso","sessions","initiate"],"host":["https://sbx.nymzie.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7c9125ab-e7a5-48b6-8a0c-b1c86b975d1b"},{"name":"Invalid Credentials Test","id":"18aebec5-5241-4808-b9e5-292612c55a42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"X-API-Key","value":"invalid_key"},{"key":"X-API-Secret","value":"invalid_secret"},{"key":"X-Source-App","value":"invalid-test-app"}],"body":{"mode":"raw","raw":"{\n \"user_id\": 23,\n \"user_type\": \"STUDENT\"\n}"},"url":"https://sbx.nymzie.com/api/v1/sso/sessions/initiate","description":"Test authentication failure with invalid credentials
\n","urlObject":{"path":["api","v1","sso","sessions","initiate"],"host":["https://sbx.nymzie.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"18aebec5-5241-4808-b9e5-292612c55a42"},{"name":"Expired Session Test","id":"ded2e3fa-6e9c-4efc-b4eb-a6a8471f84b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-API-Key","value":""},{"key":"X-API-Secret","value":""},{"key":"X-Source-App","value":"zoe-academy-smartsapp"}],"url":"https://sbx.nymzie.com/api/v1/sso/sessions/validate/expired_or_invalid_validation_token","description":"Test session validation failure with expired/invalid session
\n","urlObject":{"path":["api","v1","sso","sessions","validate","expired_or_invalid_validation_token"],"host":["https://sbx.nymzie.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ded2e3fa-6e9c-4efc-b4eb-a6a8471f84b5"}],"id":"40c6751d-f897-4986-9981-10d5842af3de","description":"Complete integration examples and test scenarios with secure validation token flow
\n","_postman_id":"40c6751d-f897-4986-9981-10d5842af3de"},{"name":"📋 Endpoint Structure","id":"1ad26719-8b3c-4a59-9bb3-e8a98f0aefa9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"User Management Service endpoints are structured as: {domain}/api/v1/users/{endpoint}. For example: https://sbx.nymzie.com/api/v1/users/sso/sessions/initiate. See SSO_PARTNER_INTEGRATION_GUIDE.md for complete documentation.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"1ad26719-8b3c-4a59-9bb3-e8a98f0aefa9"}],"event":[{"listen":"prerequest","script":{"id":"8fc918ae-d009-4e70-adb8-9a7cbb9dfe47","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"710f4bb3-664c-43d3-9cd7-7f4f8cc99175","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"base_url","value":"https://sbx.nymzie.com"},{"key":"frontend_url","value":"https://sbx.nymzie.com"},{"key":"admin_token","value":""},{"key":"partner_api_key","value":""},{"key":"partner_api_secret","value":""},{"key":"validation_token","value":""},{"key":"endpoint_structure","value":"{domain}/api/v1/users/{endpoint}"}]}