Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs][API][Asgrdeo] Introduce User Sharing API Documentation for Asgardeo #5026

Draft
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

BimsaraBodaragama
Copy link
Member

Purpose

The API introduced in #22541 allows parent organization administrators to share users with sub-organizations. This PR adds the necessary API documentation for Asgardeo, ensuring that developers have clear guidance on how to use this feature.

Goals

  • Add API documentation specifically for Asgardeo.
  • Define API structure, including endpoints, parameters, and authentication.
  • Provide request and response formats with sample payloads.
  • Include usage examples for common scenarios.

Approach

  • Created structured API documentation under Asgardeo API Docs.
  • Documented the User Sharing API, covering:
    • Endpoints: Available API paths and methods.
    • Request/Response Formats: Payload structures for different operations.
    • Usage Examples: Sample API calls with expected responses.
  • Ensured documentation adheres to WSO2 documentation standards.

Related Issue

[Docs][API][Asgardeo] Introduce User Sharing from Parent Org to Sub-Org #28754


References

Add API Support for Parent Organization Admins to Share Users with Sub-Organizations #22541

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants