API open badge Help

Authenticated Users

Auth User details

The endpoint is used to authenticate the user by verifying their credentials and retrieving their profile information.

GET

/api/v1/auth/user

{ "uuid": "56e5824b-eb63-4250-80f3-370ff4142fe7", "username": "j.doe", "email": "ivanaz.issuer@open-badge.eu", "email_verified_at": "2024-07-18 14:18:21", "created_at": "2024-07-03T15:02:45.000000Z", "updated_at": "2024-07-21T13:04:55.000000Z", "role": { "slug": "issuer", "name": "Issuer", "description": "User who issues badges", "scopes": "[\"issuer\"]" }, "profile": { "name": "John Yu", "last_name": "Donovan", "profile_picture_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/users-profile-pictures\/bXO13G1xx5jme0QotHlXpMmEdAPYL6Oy20aGlsZs.jpg", "profile_picture_high_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/users-profile-pictures\/bXO13G1xx5jme0QotHlXpMmEdAPYL6Oy20aGlsZs_high.jpg", "profile_picture_thumbnail_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/users-profile-pictures\/bXO13G1xx5jme0QotHlXpMmEdAPYL6Oy20aGlsZs_thumbnail.jpg", "settings": { "public_profile": "1", "public_badges": "0" }, "language": "it", "created_at": "2024-07-03T15:02:45.000000Z", "updated_at": "2024-09-12T17:26:04.000000Z", "t_c_accepted_at": null, }, "organization": { "id": "0f11feda-07f8-4202-9133-4a4e780e857d", "type": "public_local_national", "activity": "school", "name": "LearnQuest Academyyyyy", "description": "<p><em>Welcome to <\/em><strong>LearnQuest Academy<\/strong><em>, where education meets innovation! At LearnQuest, we offer a diverse array of courses designed to expand your knowledge and skills across various topics. Upon successful completion of each course, students earn distinctive badges, showcasing their achievements and expertise. Whether you're delving into technology, arts, sciences, or personal development, our engaging curriculum and dedicated instructors ensure a comprehensive learning experience. Join us at LearnQuest Academy and start earning your badges today!!!<\/em><\/p>", "address_info": { "city": "Example City", "state": "Example State", "region": "Example Region", "street": "123 Example Street", "country": "Example Country", "postcode": "12345" }, "billing_info": { "vat": "VAT123456", "email": "billing@open-badge.eu", "code_dest": "CODE123", "fiscal_code": "FISCAL123", "certified_email": "certified@open-badge.eu", "legal_name": "LearnQuest Academy s.r.l." }, "language": "en", "website": "https:\/\/www.example.com", "status": "enabled", "contact_info": { "name": "John", "email": "contact@open-badge.eu", "mobile": "+001234567890", "last_name": "Doe", "tech_email": "tech@open-badge.eu", "legal_email": "legal@open-badge.eu" }, "settings": { "public_profile": 1, "public_badge_types": 1, "public_learning_paths": 0, "public_badge_templates": 1 }, "logo_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/organizations\/0f11feda-07f8-4202-9133-4a4e780e857d\/organization-logos\/fOwXBgxG9qxoizXXZlkrCKaldkFdI8Ez6TWRIn35.png", "logo_high_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/organizations\/0f11feda-07f8-4202-9133-4a4e780e857d\/organization-logos\/fOwXBgxG9qxoizXXZlkrCKaldkFdI8Ez6TWRIn35_high.png", "logo_thumbnail_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/organizations\/0f11feda-07f8-4202-9133-4a4e780e857d\/organization-logos\/fOwXBgxG9qxoizXXZlkrCKaldkFdI8Ez6TWRIn35_thumbnail.png", "credits_left": 38422, "badge_templates_count": 24, "badges_count": 739, "created_at": "2024-07-03T15:02:45.000000Z", "updated_at": "2024-09-16T15:42:31.000000Z", "public_url": "https:\/\/openbadges.open-badge.eu\/public\/issuers\/0f11feda-07f8-4202-9133-4a4e780e857d", "stripe_customer_id": "cus_QpT1CW2JIJb9fL", "subscription_id": null, "subscription_status": "active", "current_period_start": "2024-09-16 13:29:49", "current_period_end": "2024-10-16 13:29:49" }, }

Edit Auth User

PUT

/api/v1/auth/user

Values that can be updated:

  • username - the username is unique and cannot have a duplicate in the system

  • email - email used for the user account

{ "uuid": "56e5824b-eb63-4250-80f3-370ff4142fe7", "username": "j.doe", "email": "ivanaz.issuer@open-badge.eu", "email_verified_at": "2024-07-18 14:18:21", "created_at": "2024-07-03T15:02:45.000000Z", "updated_at": "2024-07-21T13:04:55.000000Z", "role": { "slug": "issuer", "name": "Issuer", "description": "User who issues badges", "scopes": "[\"issuer\"]" }, "profile": { "name": "John Yuy", "last_name": "Donovan", "profile_picture_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/users-profile-pictures\/bXO13G1xx5jme0QotHlXpMmEdAPYL6Oy20aGlsZs.jpg", "profile_picture_high_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/users-profile-pictures\/bXO13G1xx5jme0QotHlXpMmEdAPYL6Oy20aGlsZs_high.jpg", "profile_picture_thumbnail_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/users-profile-pictures\/bXO13G1xx5jme0QotHlXpMmEdAPYL6Oy20aGlsZs_thumbnail.jpg", "settings": { "public_profile": "1", "public_badges": "0" }, "language": "it", "created_at": "2024-07-03T15:02:45.000000Z", "updated_at": "2024-09-16T15:49:08.000000Z", "t_c_accepted_at": null, }, "organization": { "id": "0f11feda-07f8-4202-9133-4a4e780e857d", "type": "public_local_national", "activity": "school", "name": "LearnQuest Academyyyyy", "description": "<p><em>Welcome to <\/em><strong>LearnQuest Academy<\/strong><em>, where education meets innovation! At LearnQuest, we offer a diverse array of courses designed to expand your knowledge and skills across various topics. Upon successful completion of each course, students earn distinctive badges, showcasing their achievements and expertise. Whether you're delving into technology, arts, sciences, or personal development, our engaging curriculum and dedicated instructors ensure a comprehensive learning experience. Join us at LearnQuest Academy and start earning your badges today!!!<\/em><\/p>", "address_info": { "city": "Example City", "state": "Example State", "region": "Example Region", "street": "123 Example Street", "country": "Example Country", "postcode": "12345" }, "billing_info": { "vat": "VAT123456", "email": "billing@open-badge.eu", "code_dest": "CODE123", "fiscal_code": "FISCAL123", "certified_email": "certified@open-badge.eu", "legal_name": "LearnQuest Academy s.r.l." }, "language": "en", "website": "https:\/\/www.example.com", "status": "enabled", "contact_info": { "name": "John", "email": "contact@open-badge.eu", "mobile": "+001234567890", "last_name": "Doe", "tech_email": "tech@open-badge.eu", "legal_email": "legal@open-badge.eu" }, "settings": { "public_profile": 1, "public_badge_types": 1, "public_learning_paths": 0, "public_badge_templates": 1 }, "logo_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/organizations\/0f11feda-07f8-4202-9133-4a4e780e857d\/organization-logos\/fOwXBgxG9qxoizXXZlkrCKaldkFdI8Ez6TWRIn35.png", "logo_high_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/organizations\/0f11feda-07f8-4202-9133-4a4e780e857d\/organization-logos\/fOwXBgxG9qxoizXXZlkrCKaldkFdI8Ez6TWRIn35_high.png", "logo_thumbnail_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/organizations\/0f11feda-07f8-4202-9133-4a4e780e857d\/organization-logos\/fOwXBgxG9qxoizXXZlkrCKaldkFdI8Ez6TWRIn35_thumbnail.png", "credits_left": 38422, "badge_templates_count": 24, "badges_count": 739, "created_at": "2024-07-03T15:02:45.000000Z", "updated_at": "2024-09-16T15:42:31.000000Z", "public_url": "https:\/\/openbadges.open-badge.eu\/public\/issuers\/0f11feda-07f8-4202-9133-4a4e780e857d", "stripe_customer_id": "cus_QpT1CW2JIJb9fL", "subscription_id": null, "subscription_status": "active", "current_period_start": "2024-09-16 13:29:49", "current_period_end": "2024-10-16 13:29:49" }, }

Edit user profile

The endpoint allows for updating the user's profile information, including personal details and preferences.

POST

/api/v1/auth/user/profile

Values that can be updated:

  • name - user first name

  • last_name - user last name

  • profile_picture - user profile picture

{ "data": { "name": "John Yuy", "last_name": "Donovan", "profile_picture_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/users-profile-pictures\/bXO13G1xx5jme0QotHlXpMmEdAPYL6Oy20aGlsZs.jpg", "profile_picture_high_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/users-profile-pictures\/bXO13G1xx5jme0QotHlXpMmEdAPYL6Oy20aGlsZs_high.jpg", "profile_picture_thumbnail_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/users-profile-pictures\/bXO13G1xx5jme0QotHlXpMmEdAPYL6Oy20aGlsZs_thumbnail.jpg", "settings": { "public_profile": "1", "public_badges": "0" }, "language": "it", "created_at": "2024-07-03T15:02:45.000000Z", "updated_at": "2024-09-16T15:49:08.000000Z", "t_c_accepted_at": null, } }

Password reset request

The action is used to initiate a password reset process by sending a password reset link or token to the specified email address.

GET

/api/v1/auth/request-password?email={user_email}

Required value to pass:

email - user email address associated with the user account.

{ "message": "If the account exists, an email has been sent to the provided address." }
Last modified: 12 November 2024